Skip to content

Commit

Permalink
hinoko: update documentation according to libhinoko v1.0.0 release
Browse files Browse the repository at this point in the history 
Release note:
* https://git.kernel.org/pub/scm/libs/ieee1394/libhinoko.git/tag/?h=v1.0.0

Generated by gi-docgen 2023.1:
* https://gitlab.gnome.org/GNOME/gi-docgen/-/tags/2023.1

Signed-off-by: Takashi Sakamoto <[email protected]>
  • Loading branch information
@takaswie
takaswie committed Oct 31, 2023
1 parent 196fe93 commit 28d15dc
Show file tree
Hide file tree
Showing 91 changed files with 2,262 additions and 421 deletions.
22 changes: 11 additions & 11 deletions hinoko/class.FwIsoIrMultiple.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,9 @@

<div class="section namespace">
<h3><a href="index.html">Hinoko</a></h3>
<p>API Version: 0.0</p>
<p>API Version: 1.0</p>

<p>Library Version: 0.9.1</p>
<p>Library Version: 1.0.0</p>

</div>

Expand Down Expand Up @@ -166,7 +166,7 @@ <h4 id="description" style="display:flex;">
Description
<a href="#description" class="anchor"></a>

<a class="srclink" title="go to source location" href="https://git.kernel.org/pub/scm/libs/ieee1394/libhinoko.git/tree/src/fw_iso_ir_multiple.c?h=v0.9.1#n4">[src]</a>
<a class="srclink" title="go to source location" href="https://git.kernel.org/pub/scm/libs/ieee1394/libhinoko.git/tree/src/fw_iso_ir_multiple.c?h=v1.0.0#n4">[src]</a>

</h4>

Expand All @@ -176,8 +176,8 @@ <h4 id="description" style="display:flex;">

<div class="docblock">
<p>An object to receive isochronous packet for several channels.
A <a href="class.FwIsoIrMultiple.html"><code>HinokoFwIsoIrMultiple</code></a> receives isochronous packets for several channels by <span class="caps">IR</span> context for
buffer-fill mode in 1394 <span class="caps">OHCI</span>.</p>
<a href="class.FwIsoIrMultiple.html"><code>HinokoFwIsoIrMultiple</code></a> receives isochronous packets for several channels by buffer-fill mode of
<span class="caps">IR</span> context in 1394 <span class="caps">OHCI</span>.</p>
</div>

<div class="docblock">
Expand Down Expand Up @@ -269,8 +269,8 @@ <h4 id="methods">
<div class="">
<h6><a href="method.FwIsoIrMultiple.allocate.html">hinoko_fw_iso_ir_multiple_allocate</a></h6>
<div class="docblock">
<p>Allocate an <span class="caps">IR</span> context to 1394 <span class="caps">OHCI</span> controller for buffer-fill mode. A local node of the node
corresponding to the given path is used as the controller, thus any path is accepted as long as
<p>Allocate an <span class="caps">IR</span> context to 1394 <span class="caps">OHCI</span> hardware for buffer-fill mode. A local node of the node
corresponding to the given path is used as the hardware, thus any path is accepted as long as
process has enough permission for the&nbsp;path.</p>
</div>
<div class="docblock">
Expand All @@ -292,7 +292,7 @@ <h6><a href="method.FwIsoIrMultiple.get_payload.html">hinoko_fw_iso_ir_multiple_
<div class="">
<h6><a href="method.FwIsoIrMultiple.map_buffer.html">hinoko_fw_iso_ir_multiple_map_buffer</a></h6>
<div class="docblock">
<p>Map an intermediate buffer to share payload of <span class="caps">IR</span> context with 1394 <span class="caps">OHCI</span>&nbsp;controller.</p>
<p>Map an intermediate buffer to share payload of <span class="caps">IR</span> context with 1394 <span class="caps">OHCI</span>&nbsp;hardware.</p>
</div>
<div class="docblock">
<p></p>
Expand Down Expand Up @@ -351,11 +351,11 @@ <h6><a href="method.FwIsoCtx.read_cycle_time.html">hinoko_fw_iso_ctx_read_cycle_
context is&nbsp;created.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.9</span></p>
<p><span class="emblem available">since: 1.0.</span></p>
</div>

<h6><a href="method.FwIsoCtx.release.html">hinoko_fw_iso_ctx_release</a></h6><div class="docblock">
<p>Release the contest from 1394 <span class="caps">OHCI</span>&nbsp;controller.</p>
<p>Release the contest from 1394 <span class="caps">OHCI</span>&nbsp;hardware.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.7</span></p>
Expand All @@ -369,7 +369,7 @@ <h6><a href="method.FwIsoCtx.stop.html">hinoko_fw_iso_ctx_stop</a></h6><div clas
</div>

<h6><a href="method.FwIsoCtx.unmap_buffer.html">hinoko_fw_iso_ctx_unmap_buffer</a></h6><div class="docblock">
<p>Unmap intermediate buffer shared with 1394 <span class="caps">OHCI</span> controller for the&nbsp;context.</p>
<p>Unmap intermediate buffer shared with 1394 <span class="caps">OHCI</span> hardware for the&nbsp;context.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.7</span></p>
Expand Down
25 changes: 12 additions & 13 deletions hinoko/class.FwIsoIrSingle.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,9 @@

<div class="section namespace">
<h3><a href="index.html">Hinoko</a></h3>
<p>API Version: 0.0</p>
<p>API Version: 1.0</p>

<p>Library Version: 0.9.1</p>
<p>Library Version: 1.0.0</p>

</div>

Expand Down Expand Up @@ -159,7 +159,7 @@ <h4 id="description" style="display:flex;">
Description
<a href="#description" class="anchor"></a>

<a class="srclink" title="go to source location" href="https://git.kernel.org/pub/scm/libs/ieee1394/libhinoko.git/tree/src/fw_iso_ir_single.c?h=v0.9.1#n4">[src]</a>
<a class="srclink" title="go to source location" href="https://git.kernel.org/pub/scm/libs/ieee1394/libhinoko.git/tree/src/fw_iso_ir_single.c?h=v1.0.0#n4">[src]</a>

</h4>

Expand All @@ -169,10 +169,9 @@ <h4 id="description" style="display:flex;">

<div class="docblock">
<p>An object to receive isochronous packet for single channel.
A <a href="class.FwIsoIrSingle.html"><code>HinokoFwIsoIrSingle</code></a> receives isochronous packets for single channel by <span class="caps">IR</span>
context for packet-per-buffer mode in 1394 <span class="caps">OHCI</span>. The content of packet is
split to two parts; context header and context payload in a manner of Linux
FireWire&nbsp;subsystem.</p>
<a href="class.FwIsoIrSingle.html"><code>HinokoFwIsoIrSingle</code></a> receives isochronous packets for single channel by packet-per-buffer
mode of <span class="caps">IR</span> context in 1394 <span class="caps">OHCI</span>. The content of packet is split to two parts; context header and
context payload in a manner of Linux FireWire&nbsp;subsystem.</p>
</div>

<div class="docblock">
Expand Down Expand Up @@ -264,8 +263,8 @@ <h4 id="methods">
<div class="">
<h6><a href="method.FwIsoIrSingle.allocate.html">hinoko_fw_iso_ir_single_allocate</a></h6>
<div class="docblock">
<p>Allocate an <span class="caps">IR</span> context to 1394 <span class="caps">OHCI</span> controller for packet-per-buffer mode. A local node of the
node corresponding to the given path is used as the controller, thus any path is accepted as
<p>Allocate an <span class="caps">IR</span> context to 1394 <span class="caps">OHCI</span> hardware for packet-per-buffer mode. A local node of the
node corresponding to the given path is used as the hardware, thus any path is accepted as
long as process has enough permission for the&nbsp;path.</p>
</div>
<div class="docblock">
Expand All @@ -286,7 +285,7 @@ <h6><a href="method.FwIsoIrSingle.get_payload.html">hinoko_fw_iso_ir_single_get_
<div class="">
<h6><a href="method.FwIsoIrSingle.map_buffer.html">hinoko_fw_iso_ir_single_map_buffer</a></h6>
<div class="docblock">
<p>Map intermediate buffer to share payload of <span class="caps">IR</span> context with 1394 <span class="caps">OHCI</span>&nbsp;controller.</p>
<p>Map intermediate buffer to share payload of <span class="caps">IR</span> context with 1394 <span class="caps">OHCI</span>&nbsp;hardware.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.7</span></p>
Expand Down Expand Up @@ -357,11 +356,11 @@ <h6><a href="method.FwIsoCtx.read_cycle_time.html">hinoko_fw_iso_ctx_read_cycle_
context is&nbsp;created.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.9</span></p>
<p><span class="emblem available">since: 1.0.</span></p>
</div>

<h6><a href="method.FwIsoCtx.release.html">hinoko_fw_iso_ctx_release</a></h6><div class="docblock">
<p>Release the contest from 1394 <span class="caps">OHCI</span>&nbsp;controller.</p>
<p>Release the contest from 1394 <span class="caps">OHCI</span>&nbsp;hardware.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.7</span></p>
Expand All @@ -375,7 +374,7 @@ <h6><a href="method.FwIsoCtx.stop.html">hinoko_fw_iso_ctx_stop</a></h6><div clas
</div>

<h6><a href="method.FwIsoCtx.unmap_buffer.html">hinoko_fw_iso_ctx_unmap_buffer</a></h6><div class="docblock">
<p>Unmap intermediate buffer shared with 1394 <span class="caps">OHCI</span> controller for the&nbsp;context.</p>
<p>Unmap intermediate buffer shared with 1394 <span class="caps">OHCI</span> hardware for the&nbsp;context.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.7</span></p>
Expand Down
20 changes: 10 additions & 10 deletions hinoko/class.FwIsoIt.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,9 @@

<div class="section namespace">
<h3><a href="index.html">Hinoko</a></h3>
<p>API Version: 0.0</p>
<p>API Version: 1.0</p>

<p>Library Version: 0.9.1</p>
<p>Library Version: 1.0.0</p>

</div>

Expand Down Expand Up @@ -157,7 +157,7 @@ <h4 id="description" style="display:flex;">
Description
<a href="#description" class="anchor"></a>

<a class="srclink" title="go to source location" href="https://git.kernel.org/pub/scm/libs/ieee1394/libhinoko.git/tree/src/fw_iso_it.c?h=v0.9.1#n4">[src]</a>
<a class="srclink" title="go to source location" href="https://git.kernel.org/pub/scm/libs/ieee1394/libhinoko.git/tree/src/fw_iso_it.c?h=v1.0.0#n4">[src]</a>

</h4>

Expand All @@ -167,7 +167,7 @@ <h4 id="description" style="display:flex;">

<div class="docblock">
<p>An object to transmit isochronous packet for single channel.
A <a href="class.FwIsoIt.html"><code>HinokoFwIsoIt</code></a> transmits isochronous packets for single channel by <span class="caps">IT</span> context in 1394 <span class="caps">OHCI</span>.
<a href="class.FwIsoIt.html"><code>HinokoFwIsoIt</code></a> transmits isochronous packets for single channel by <span class="caps">IT</span> context in 1394 <span class="caps">OHCI</span>.
The content of packet is split to two parts; context header and context payload in a manner of
Linux FireWire&nbsp;subsystem.</p>
</div>
Expand Down Expand Up @@ -261,8 +261,8 @@ <h4 id="methods">
<div class="">
<h6><a href="method.FwIsoIt.allocate.html">hinoko_fw_iso_it_allocate</a></h6>
<div class="docblock">
<p>Allocate an <span class="caps">IT</span> context to 1394 <span class="caps">OHCI</span> controller. A local node of the node corresponding to the
given path is used as the controller, thus any path is accepted as long as process has enough
<p>Allocate an <span class="caps">IT</span> context to 1394 <span class="caps">OHCI</span> hardware. A local node of the node corresponding to the
given path is used as the hardware, thus any path is accepted as long as process has enough
permission for the&nbsp;path.</p>
</div>
<div class="docblock">
Expand All @@ -273,7 +273,7 @@ <h6><a href="method.FwIsoIt.allocate.html">hinoko_fw_iso_it_allocate</a></h6>
<div class="">
<h6><a href="method.FwIsoIt.map_buffer.html">hinoko_fw_iso_it_map_buffer</a></h6>
<div class="docblock">
<p>Map intermediate buffer to share payload of <span class="caps">IT</span> context with 1394 <span class="caps">OHCI</span>&nbsp;controller.</p>
<p>Map intermediate buffer to share payload of <span class="caps">IT</span> context with 1394 <span class="caps">OHCI</span>&nbsp;hardware.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.7</span></p>
Expand Down Expand Up @@ -345,11 +345,11 @@ <h6><a href="method.FwIsoCtx.read_cycle_time.html">hinoko_fw_iso_ctx_read_cycle_
context is&nbsp;created.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.9</span></p>
<p><span class="emblem available">since: 1.0.</span></p>
</div>

<h6><a href="method.FwIsoCtx.release.html">hinoko_fw_iso_ctx_release</a></h6><div class="docblock">
<p>Release the contest from 1394 <span class="caps">OHCI</span>&nbsp;controller.</p>
<p>Release the contest from 1394 <span class="caps">OHCI</span>&nbsp;hardware.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.7</span></p>
Expand All @@ -363,7 +363,7 @@ <h6><a href="method.FwIsoCtx.stop.html">hinoko_fw_iso_ctx_stop</a></h6><div clas
</div>

<h6><a href="method.FwIsoCtx.unmap_buffer.html">hinoko_fw_iso_ctx_unmap_buffer</a></h6><div class="docblock">
<p>Unmap intermediate buffer shared with 1394 <span class="caps">OHCI</span> controller for the&nbsp;context.</p>
<p>Unmap intermediate buffer shared with 1394 <span class="caps">OHCI</span> hardware for the&nbsp;context.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.7</span></p>
Expand Down
28 changes: 14 additions & 14 deletions hinoko/class.FwIsoResourceAuto.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,9 +62,9 @@

<div class="section namespace">
<h3><a href="index.html">Hinoko</a></h3>
<p>API Version: 0.0</p>
<p>API Version: 1.0</p>

<p>Library Version: 0.9.1</p>
<p>Library Version: 1.0.0</p>

</div>

Expand Down Expand Up @@ -93,9 +93,9 @@ <h5>Constructors</h5>
<h5>Instance methods</h5>
<div class="links">

<a class="method" href="method.FwIsoResourceAuto.deallocate_async.html">deallocate_async</a>
<a class="method" href="method.FwIsoResourceAuto.deallocate.html">deallocate</a>

<a class="method" href="method.FwIsoResourceAuto.deallocate_sync.html">deallocate_sync</a>
<a class="method" href="method.FwIsoResourceAuto.deallocate_wait.html">deallocate_wait</a>

</div>
</div>
Expand Down Expand Up @@ -148,7 +148,7 @@ <h4 id="description" style="display:flex;">
Description
<a href="#description" class="anchor"></a>

<a class="srclink" title="go to source location" href="https://git.kernel.org/pub/scm/libs/ieee1394/libhinoko.git/tree/src/fw_iso_resource_auto.c?h=v0.9.1#n4">[src]</a>
<a class="srclink" title="go to source location" href="https://git.kernel.org/pub/scm/libs/ieee1394/libhinoko.git/tree/src/fw_iso_resource_auto.c?h=v1.0.0#n4">[src]</a>

</h4>

Expand All @@ -158,7 +158,7 @@ <h4 id="description" style="display:flex;">

<div class="docblock">
<p>An object to maintain allocated isochronous resource.
A <a href="class.FwIsoResourceAuto.html"><code>HinokoFwIsoResourceAuto</code></a>is an object to maintain isochronous resource during the lifetime of
<a href="class.FwIsoResourceAuto.html"><code>HinokoFwIsoResourceAuto</code></a>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&nbsp;subsystem.</p>
</div>
Expand Down Expand Up @@ -250,24 +250,24 @@ <h4 id="methods">
<div class="docblock">

<div class="">
<h6><a href="method.FwIsoResourceAuto.deallocate_async.html">hinoko_fw_iso_resource_auto_deallocate_async</a></h6>
<h6><a href="method.FwIsoResourceAuto.deallocate.html">hinoko_fw_iso_resource_auto_deallocate</a></h6>
<div class="docblock">
<p>Initiate deallocation of isochronous resource. When the deallocation is done,
<code>HinokoFwIsoResource::deallocated</code> signal is emit to notify the result, channel, and&nbsp;bandwidth.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.7</span></p>
<p><span class="emblem available">since: 1.0</span></p>
</div>
</div>

<div class="">
<h6><a href="method.FwIsoResourceAuto.deallocate_sync.html">hinoko_fw_iso_resource_auto_deallocate_sync</a></h6>
<h6><a href="method.FwIsoResourceAuto.deallocate_wait.html">hinoko_fw_iso_resource_auto_deallocate_wait</a></h6>
<div class="docblock">
<p>Initiate deallocation of isochronous resource. When the deallocation is done,
<code>HinokoFwIsoResource::deallocated</code> signal is emit to notify the result, channel, and&nbsp;bandwidth.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.7</span></p>
<p><span class="emblem available">since: 1.0</span></p>
</div>
</div>

Expand All @@ -292,21 +292,21 @@ <h6><a href="method.FwIsoResourceAuto.deallocate_sync.html">hinoko_fw_iso_resour
<div class="toggle-wrapper default-hide ancestor-methods">
<h5 style="display:block;">Methods inherited from <a href="iface.FwIsoResource.html">HinokoFwIsoResource</a> (4)</h5><div class="docblock">

<h6><a href="method.FwIsoResource.allocate_async.html">hinoko_fw_iso_resource_allocate_async</a></h6><div class="docblock">
<h6><a href="method.FwIsoResource.allocate.html">hinoko_fw_iso_resource_allocate</a></h6><div class="docblock">
<p>Initiate allocation of isochronous resource without any wait. One of the candidates is actually
allocated for channel. When the allocation finishes, <code>HinokoFwIsoResource::allocated</code> signal is
emitted to notify the result, channel, and&nbsp;bandwidth.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.7</span></p>
<p><span class="emblem available">since: 1.0</span></p>
</div>

<h6><a href="method.FwIsoResource.allocate_sync.html">hinoko_fw_iso_resource_allocate_sync</a></h6><div class="docblock">
<h6><a href="method.FwIsoResource.allocate_wait.html">hinoko_fw_iso_resource_allocate_wait</a></h6><div class="docblock">
<p>Initiate allocation of isochronous resource and wait for <code>HinokoFwIsoResource::allocated</code>
signal. One of the candidates is actually allocated for&nbsp;channel.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 0.7</span></p>
<p><span class="emblem available">since: 1.0</span></p>
</div>

<h6><a href="method.FwIsoResource.create_source.html">hinoko_fw_iso_resource_create_source</a></h6><div class="docblock">
Expand Down
Loading

0 comments on commit 28d15dc

Please sign in to comment.