Skip to content

Commit

Permalink
hinawa: update documentation according to libhinawa v4.0.0 release
Browse files Browse the repository at this point in the history 
Release note:
* https://git.kernel.org/pub/scm/libs/ieee1394/libhinawa.git/tag/?h=4.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 29, 2023
1 parent 261f3b6 commit 196fe93
Show file tree
Hide file tree
Showing 71 changed files with 1,452 additions and 947 deletions.
187 changes: 49 additions & 138 deletions hinawa/class.FwFcp.html
View file

Large diffs are not rendered by default.

57 changes: 35 additions & 22 deletions hinawa/class.FwNode.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">Hinawa</a></h3>
<p>API Version: 3.0</p>
<p>API Version: 4.0</p>

<p>Library Version: 2.6.1</p>
<p>Library Version: 4.0.0</p>

</div>

Expand Down Expand Up @@ -112,6 +112,8 @@ <h5>Properties</h5>

<a class="property" href="property.FwNode.bus-manager-node-id.html">bus-manager-node-id</a>

<a class="property" href="property.FwNode.card-id.html">card-id</a>

<a class="property" href="property.FwNode.generation.html">generation</a>

<a class="property" href="property.FwNode.ir-manager-node-id.html">ir-manager-node-id</a>
Expand Down Expand Up @@ -172,15 +174,15 @@ <h1 aria-label="Name"><a href="index.html">Hinawa</a><span class="sep" role="pre
<section>
<summary>
<div class="docblock">
<p><span class="emblem available">since: 1.4.</span></p>
<p><span class="emblem available">since: 1.4</span></p>
</div>

<div class="toggle-wrapper">
<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/libhinawa.git/tree/src/fw_node.c?h=2.6.1#n11">[src]</a>
<a class="srclink" title="go to source location" href="https://git.kernel.org/pub/scm/libs/ieee1394/libhinawa.git/tree/src/fw_node.c?h=4.0.0#n11">[src]</a>

</h4>

Expand All @@ -189,16 +191,15 @@ <h4 id="description" style="display:flex;">
}</pre></code>

<div class="docblock">
<p>An event listener for FireWire node
A <a href="class.FwNode.html"><code>HinawaFwNode</code></a> is an event listener for a specified node on <span class="caps">IEEE</span> 1394 bus. This class is an
application of Linux FireWire subsystem. All of operations utilize ioctl(2) with subsystem
specific request&nbsp;commands.</p>
<p>An event listener for node in <span class="caps">IEEE</span> 1394 bus.
<a href="class.FwNode.html"><code>HinawaFwNode</code></a> listens to any events for an associated node in <span class="caps">IEEE</span> 1394 bus. Additionally,
it provides some methods to retrieve fundamental information about the&nbsp;bus.</p>
</div>

<div class="docblock">


<p>Available since: 1.4.</p>
<p>Available since: 1.4</p>


</div>
Expand Down Expand Up @@ -247,7 +248,7 @@ <h6><a href="ctor.FwNode.new.html">hinawa_fw_node_new</a></h6>
<p>Instantiate <code>HinawaFwNode</code> object and return the&nbsp;instance.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 1.4.</span></p>
<p><span class="emblem available">since: 1.4</span></p>
</div>
</div>

Expand All @@ -273,7 +274,7 @@ <h6><a href="method.FwNode.create_source.html">hinawa_fw_node_create_source</a><
<span class="caps">IEEE</span> 1394&nbsp;bus.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 1.4.</span></p>
<p><span class="emblem available">since: 4.0</span></p>
</div>
</div>

Expand All @@ -283,27 +284,28 @@ <h6><a href="method.FwNode.get_config_rom.html">hinawa_fw_node_get_config_rom</a
<p>Get cached content of configuration <span class="caps">ROM</span> aligned to&nbsp;big-endian.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 1.4.</span></p>
<p><span class="emblem available">since: 4.0</span></p>
</div>
</div>

<div class="">
<h6><a href="method.FwNode.open.html">hinawa_fw_node_open</a></h6>
<div class="docblock">
<p>Open Linux FireWire character device to operate node on <span class="caps">IEEE</span> 1394&nbsp;bus.</p>
<p>Open Linux FireWire character device to operate node in <span class="caps">IEEE</span> 1394&nbsp;bus.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 1.4.</span></p>
<p><span class="emblem available">since: 4.0</span></p>
</div>
</div>

<div class="">
<h6><a href="method.FwNode.read_cycle_time.html">hinawa_fw_node_read_cycle_time</a></h6>
<div class="docblock">
<p>Read current value of CYCLE_TIME register in 1394 <span class="caps">OHCI</span>&nbsp;controller.</p>
<p>Read current value of CYCLE_TIME register in 1394 <span class="caps">OHCI</span> hardware dedicated to communicate with
the associated node in <span class="caps">IEEE</span> 1394&nbsp;bus.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 2.6.</span></p>
<p><span class="emblem available">since: 4.0</span></p>
</div>
</div>

Expand Down Expand Up @@ -347,6 +349,17 @@ <h6><a href="property.FwNode.bus-manager-node-id.html">Hinawa.FwNode:bus-manager
</div>
</div>

<div class="">
<h6><a href="property.FwNode.card-id.html">Hinawa.FwNode:card-id</a></h6>
<div class="docblock">
<p>The numeric index for 1394 <span class="caps">OHCI</span> hardware used for the communication with the node. The
value is stable against bus&nbsp;generation.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 4.0</span></p>
</div>
</div>

<div class="">
<h6><a href="property.FwNode.generation.html">Hinawa.FwNode:generation</a></h6>
<div class="docblock">
Expand All @@ -372,7 +385,7 @@ <h6><a href="property.FwNode.ir-manager-node-id.html">Hinawa.FwNode:ir-manager-n
<h6><a href="property.FwNode.local-node-id.html">Hinawa.FwNode:local-node-id</a></h6>
<div class="docblock">
<p>Node <span class="caps">ID</span> of node which application uses to communicate to node associated to instance of
object at current generation of bus topology. In general, it is for 1394 <span class="caps">OHCI</span>&nbsp;controller.</p>
object at current generation of bus topology. In general, it is for 1394 <span class="caps">OHCI</span>&nbsp;hardware.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 1.4</span></p>
Expand All @@ -393,7 +406,7 @@ <h6><a href="property.FwNode.node-id.html">Hinawa.FwNode:node-id</a></h6>
<div class="">
<h6><a href="property.FwNode.root-node-id.html">Hinawa.FwNode:root-node-id</a></h6>
<div class="docblock">
<p>Node <span class="caps">ID</span> of root node in bus topology at current generation of the bus&nbsp;topology.</p>
<p>Node <span class="caps">ID</span> of root node in bus topology at current generation of bus&nbsp;topology.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 1.4</span></p>
Expand Down Expand Up @@ -436,8 +449,8 @@ <h6><a href="signal.FwNode.bus-update.html">Hinawa.FwNode::bus-update</a></h6>
<div class="">
<h6><a href="signal.FwNode.disconnected.html">Hinawa.FwNode::disconnected</a></h6>
<div class="docblock">
<p>Emitted when the node is not available anymore due to removal from <span class="caps">IEEE</span> 1394 bus. It&#8217;s
preferable to call <code>g_object_unref()</code> immediately to release file&nbsp;descriptor.</p>
<p>Emitted when the node is not available anymore in Linux system. It&#8217;s preferable to call
<code>g_object_unref()</code> immediately to release file&nbsp;descriptor.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 1.4</span></p>
Expand Down Expand Up @@ -534,7 +547,7 @@ <h6 id="vfunc-bus_update"><a href="vfunc.FwNode.bus_update.html">Hinawa.FwNodeCl
<p>Class closure for the <code>HinawaFwNode::bus-update</code>.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 1.4.</span></p>
<p><span class="emblem available">since: 1.4</span></p>
</div>
</div>

Expand All @@ -544,7 +557,7 @@ <h6 id="vfunc-disconnected"><a href="vfunc.FwNode.disconnected.html">Hinawa.FwNo
<p>Class closure for the <code>HinawaFwNode::disconnected</code>.</p>
</div>
<div class="docblock">
<p><span class="emblem available">since: 1.4.</span></p>
<p><span class="emblem available">since: 1.4</span></p>
</div>
</div>

Expand Down
Loading

0 comments on commit 196fe93

Please sign in to comment.