diff options
author | Takashi Sakamoto <o-takashi@sakamocchi.jp> | 2023-10-30 23:00:07 +0900 |
---|---|---|
committer | Takashi Sakamoto <o-takashi@sakamocchi.jp> | 2023-10-30 23:00:07 +0900 |
commit | f94a13a98a38b2d416bf8172d0a8134ca57e8a3d (patch) | |
tree | 2d39c159387fd5a1c6374ffc9a74fc8078c882bf | |
parent | 2ab54dcbf03763af3581264028f4047e9205169a (diff) | |
download | libhinoko-f94a13a98a38b2d416bf8172d0a8134ca57e8a3d.tar.gz |
doc: update desctiption about objects
For users' readability.
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
-rw-r--r-- | src/fw_iso_ctx.c | 6 | ||||
-rw-r--r-- | src/fw_iso_ir_multiple.c | 4 | ||||
-rw-r--r-- | src/fw_iso_ir_single.c | 7 | ||||
-rw-r--r-- | src/fw_iso_it.c | 2 | ||||
-rw-r--r-- | src/fw_iso_resource.c | 6 | ||||
-rw-r--r-- | src/fw_iso_resource_auto.c | 2 |
6 files changed, 13 insertions, 14 deletions
diff --git a/src/fw_iso_ctx.c b/src/fw_iso_ctx.c index c53a213..7318640 100644 --- a/src/fw_iso_ctx.c +++ b/src/fw_iso_ctx.c @@ -5,10 +5,10 @@ /** * HinokoFwIsoCtx - * An basic interface to operate isochronous context on 1394 OHCI hardware. + * A set of basic interfaces to operate isochronous context on 1394 OHCI hardware. * - * A [iface@FwIsoCtx] is an basic interface to use UAPI of Linux FireWire subsystem to operate - * 1394 OHCI hardware. + * [iface@FwIsoCtx] includes interfaces to operate 1394 OHCI hardware for isochronous communication + * by any kind of contexts. */ G_DEFINE_INTERFACE(HinokoFwIsoCtx, hinoko_fw_iso_ctx, G_TYPE_OBJECT) diff --git a/src/fw_iso_ir_multiple.c b/src/fw_iso_ir_multiple.c index f4bf0a4..d2c5912 100644 --- a/src/fw_iso_ir_multiple.c +++ b/src/fw_iso_ir_multiple.c @@ -5,8 +5,8 @@ * HinokoFwIsoIrMultiple: * An object to receive isochronous packet for several channels. * - * A [class@FwIsoIrMultiple] receives isochronous packets for several channels by IR context for - * buffer-fill mode in 1394 OHCI. + * [class@FwIsoIrMultiple] receives isochronous packets for several channels by buffer-fill mode of + * IR context in 1394 OHCI. */ struct ctx_payload { unsigned int offset; diff --git a/src/fw_iso_ir_single.c b/src/fw_iso_ir_single.c index a516684..d6244d1 100644 --- a/src/fw_iso_ir_single.c +++ b/src/fw_iso_ir_single.c @@ -5,10 +5,9 @@ * HinokoFwIsoIrSingle: * An object to receive isochronous packet for single channel. * - * A [class@FwIsoIrSingle] receives isochronous packets for single channel by IR - * context for packet-per-buffer mode in 1394 OHCI. The content of packet is - * split to two parts; context header and context payload in a manner of Linux - * FireWire subsystem. + * [class@FwIsoIrSingle] receives isochronous packets for single channel by packet-per-buffer + * mode of IR context in 1394 OHCI. The content of packet is split to two parts; context header and + * context payload in a manner of Linux FireWire subsystem. * */ typedef struct { diff --git a/src/fw_iso_it.c b/src/fw_iso_it.c index 852a5e8..d2e0b85 100644 --- a/src/fw_iso_it.c +++ b/src/fw_iso_it.c @@ -5,7 +5,7 @@ * HinokoFwIsoIt: * An object to transmit isochronous packet for single channel. * - * A [class@FwIsoIt] transmits isochronous packets for single channel by IT context in 1394 OHCI. + * [class@FwIsoIt] transmits isochronous packets for single channel by IT context in 1394 OHCI. * The content of packet is split to two parts; context header and context payload in a manner of * Linux FireWire subsystem. */ diff --git a/src/fw_iso_resource.c b/src/fw_iso_resource.c index 325d901..6145cfe 100644 --- a/src/fw_iso_resource.c +++ b/src/fw_iso_resource.c @@ -3,10 +3,10 @@ /** * HinokoFwIsoResource: - * An interface object to listen events of isochronous resource allocation and deallocation. + * A set of basic interfaces to listen to events about isochronous resource. * - * The [iface@FwIsoResource] should be implemented in GObject-derived object to listen events of - * isochronous resource allocation and deallocation. + * [iface@FwIsoResource] includes interfaces to listen to events about allocation and + * deallocation of isochronous resource. * * Since: 0.7 */ diff --git a/src/fw_iso_resource_auto.c b/src/fw_iso_resource_auto.c index 532e0be..d1c2a1d 100644 --- a/src/fw_iso_resource_auto.c +++ b/src/fw_iso_resource_auto.c @@ -5,7 +5,7 @@ * HinokoFwIsoResourceAuto: * An object to maintain allocated isochronous resource. * - * A [class@FwIsoResourceAuto]is an object to maintain isochronous resource during the lifetime of + * [class@FwIsoResourceAuto]is an object to maintain isochronous resource during the lifetime of * the object. The allocated isochronous resource is kept even if the generation of the bus * updates. The maintenance of allocated isochronous resource is done by Linux FireWire subsystem. */ |