aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTakashi Sakamoto <o-takashi@sakamocchi.jp>2023-11-05 17:12:23 +0900
committerTakashi Sakamoto <o-takashi@sakamocchi.jp>2023-11-05 17:12:23 +0900
commitc1db41b0620e7fbbcfc8f5a76d804b4b400f7e98 (patch)
treecf60aebfb2bfa1f377c97b1479ee5d22456e761b
parentb2b696868913323c40c17e7c34dfd4f4fea4a170 (diff)
downloadhinawa-rs-c1db41b0620e7fbbcfc8f5a76d804b4b400f7e98.tar.gz
hinawa: insert line break for human visibility
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
-rw-r--r--hinawa/src/auto/cycle_time.rs1
-rw-r--r--hinawa/src/auto/enums.rs1
-rw-r--r--hinawa/src/auto/fw_fcp.rs1
-rw-r--r--hinawa/src/auto/fw_node.rs1
-rw-r--r--hinawa/src/auto/fw_req.rs1
-rw-r--r--hinawa/src/auto/fw_resp.rs1
6 files changed, 6 insertions, 0 deletions
diff --git a/hinawa/src/auto/cycle_time.rs b/hinawa/src/auto/cycle_time.rs
index 172f819..0ef9382 100644
--- a/hinawa/src/auto/cycle_time.rs
+++ b/hinawa/src/auto/cycle_time.rs
@@ -8,6 +8,7 @@ use std::mem;
glib::wrapper! {
/// A boxed object to express data of cycle time.
+ ///
/// A [`CycleTime`][crate::CycleTime] expresses the value of cycle time of 1394 OHCI as well as Linux system
/// time referring to clock_id.
#[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
diff --git a/hinawa/src/auto/enums.rs b/hinawa/src/auto/enums.rs
index 52abc15..ef8b566 100644
--- a/hinawa/src/auto/enums.rs
+++ b/hinawa/src/auto/enums.rs
@@ -378,6 +378,7 @@ impl ToValue for FwRcode {
}
/// A set of error code for [`glib::Error`][crate::glib::Error] for operations in [`FwReq`][crate::FwReq].
+///
/// The actual value is equivalent to [`FwRcode`][crate::FwRcode].
#[derive(Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Clone, Copy)]
#[non_exhaustive]
diff --git a/hinawa/src/auto/fw_fcp.rs b/hinawa/src/auto/fw_fcp.rs
index 60cf92f..b769820 100644
--- a/hinawa/src/auto/fw_fcp.rs
+++ b/hinawa/src/auto/fw_fcp.rs
@@ -17,6 +17,7 @@ use std::ptr;
glib::wrapper! {
/// A FCP transaction executor to node in IEEE 1394 bus.
+ ///
/// [`FwFcp`][crate::FwFcp] supports Function Control Protocol (FCP) in IEC 61883-1. FCP transaction consists
/// of a pair of asynchronous transactions for command and response, while the protocol has no
/// mechanism to match them. In AV/C Digital Interface Command Set General Specification Version 4.2
diff --git a/hinawa/src/auto/fw_node.rs b/hinawa/src/auto/fw_node.rs
index a4a3201..ce33b05 100644
--- a/hinawa/src/auto/fw_node.rs
+++ b/hinawa/src/auto/fw_node.rs
@@ -15,6 +15,7 @@ use std::ptr;
glib::wrapper! {
/// An event listener for node in IEEE 1394 bus.
+ ///
/// [`FwNode`][crate::FwNode] listens to any events for an associated node in IEEE 1394 bus. Additionally,
/// it provides some methods to retrieve fundamental information about the bus.
///
diff --git a/hinawa/src/auto/fw_req.rs b/hinawa/src/auto/fw_req.rs
index de3a3aa..b8b07ec 100644
--- a/hinawa/src/auto/fw_req.rs
+++ b/hinawa/src/auto/fw_req.rs
@@ -8,6 +8,7 @@ use std::fmt;
glib::wrapper! {
/// A transaction executor to a node in IEEE 1394 bus.
+ ///
/// [`FwReq`][crate::FwReq] supports all types of transactions defiend in IEEE 1212.
///
/// # Implements
diff --git a/hinawa/src/auto/fw_resp.rs b/hinawa/src/auto/fw_resp.rs
index be3509f..697adca 100644
--- a/hinawa/src/auto/fw_resp.rs
+++ b/hinawa/src/auto/fw_resp.rs
@@ -16,6 +16,7 @@ use std::ptr;
glib::wrapper! {
/// A transaction responder for request subaction initiated by node in IEEE 1394 bus.
+ ///
/// [`FwResp`][crate::FwResp] responds to request subaction initiated by node in IEEE 1394 bus.
///
/// # Implements