diff options
author | Takashi Sakamoto <o-takashi@sakamocchi.jp> | 2023-07-23 18:09:54 +0900 |
---|---|---|
committer | Takashi Sakamoto <o-takashi@sakamocchi.jp> | 2023-10-03 21:45:12 +0900 |
commit | a56d512bab926e1c907e03f84fdfc65a0aef2c9e (patch) | |
tree | 44ae3abb900a5ac9d48549139ecc7a12c8670071 | |
parent | 7bac9d18d23f75b85ccd91cb50f06ca4f925d254 (diff) | |
download | libhinawa-a56d512bab926e1c907e03f84fdfc65a0aef2c9e.tar.gz |
correct format of Since and Deprecated tags
No dot following to numeric version.
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
-rw-r--r-- | src/cycle_time.c | 10 | ||||
-rw-r--r-- | src/fw_fcp.c | 14 | ||||
-rw-r--r-- | src/fw_node.c | 12 | ||||
-rw-r--r-- | src/fw_node.h | 4 | ||||
-rw-r--r-- | src/fw_req.c | 4 | ||||
-rw-r--r-- | src/fw_resp.c | 8 |
6 files changed, 26 insertions, 26 deletions
diff --git a/src/cycle_time.c b/src/cycle_time.c index 2e39dca..5023230 100644 --- a/src/cycle_time.c +++ b/src/cycle_time.c @@ -30,7 +30,7 @@ G_DEFINE_BOXED_TYPE(HinawaCycleTime, hinawa_cycle_time, hinawa_cycle_time_copy, * * Returns: (transfer full): An instance of [struct@CycleTime]. * - * Since: 2.6. + * Since: 2.6 */ HinawaCycleTime *hinawa_cycle_time_new() { @@ -46,7 +46,7 @@ HinawaCycleTime *hinawa_cycle_time_new() * Get system time with enough size of strorage. The timestamp refers to clock_id available by * [method@CycleTime.get_clock_id]. * - * Since: 2.6. + * Since: 2.6 */ void hinawa_cycle_time_get_system_time(const HinawaCycleTime *self, gint64 *tv_sec, gint32 *tv_nsec) { @@ -63,7 +63,7 @@ void hinawa_cycle_time_get_system_time(const HinawaCycleTime *self, gint64 *tv_s * * Get the ID of clock for timestamp. * - * Since: 2.6. + * Since: 2.6 */ void hinawa_cycle_time_get_clock_id(const HinawaCycleTime *self, gint *clock_id) { @@ -101,7 +101,7 @@ static guint ieee1394_cycle_time_to_offset(guint32 cycle_time) * value of sec field, up to 127. The second element of array expresses the value of cycle field, * up to 7999. The third element of array expresses the value of offset field, up to 3071. * - * Since: 2.6. + * Since: 2.6 */ void hinawa_cycle_time_get_fields(const HinawaCycleTime *self, guint16 fields[3]) { @@ -117,7 +117,7 @@ void hinawa_cycle_time_get_fields(const HinawaCycleTime *self, guint16 fields[3] * * Get the value of cycle time in 1394 OHCI controller. * - * Since: 2.6. + * Since: 2.6 */ void hinawa_cycle_time_get_raw(const HinawaCycleTime *self, guint32 *raw) { diff --git a/src/fw_fcp.c b/src/fw_fcp.c index c3a6c19..853fce4 100644 --- a/src/fw_fcp.c +++ b/src/fw_fcp.c @@ -157,7 +157,7 @@ static void hinawa_fw_fcp_class_init(HinawaFwFcpClass *klass) * If the version of kernel ABI for Linux FireWire subsystem is less than 6, the value of * @tstamp argument has invalid value (=G_MAXUINT). * - * Since: 2.6. + * Since: 2.6 */ fw_fcp_sigs[FW_FCP_SIG_TYPE_RESPONDED2] = g_signal_new("responded2", @@ -181,7 +181,7 @@ static void hinawa_fw_fcp_init(HinawaFwFcp *self) * Instantiate [class@FwFcp] object and return the instance. * * Returns: an instance of [class@FwFcp]. - * Since: 1.3. + * Since: 1.3 */ HinawaFwFcp *hinawa_fw_fcp_new(void) { @@ -231,7 +231,7 @@ static gboolean complete_command_transaction(HinawaFwFcp *self, const guint8 *cm * * Returns: TRUE if the overall operation finishes successfully, otherwise FALSE. * - * Since: 3.0. + * Since: 3.0 */ gboolean hinawa_fw_fcp_command(HinawaFwFcp *self, const guint8 *cmd, gsize cmd_size, guint timeout_ms, GError **error) @@ -265,7 +265,7 @@ gboolean hinawa_fw_fcp_command(HinawaFwFcp *self, const guint8 *cmd, gsize cmd_s * has invalid value (=G_MAXUINT16). * * Returns: TRUE if the overall operation finishes successfully, otherwise FALSE. - * Since: 2.6. + * Since: 2.6 */ gboolean hinawa_fw_fcp_command_with_tstamp(HinawaFwFcp *self, const guint8 *cmd, gsize cmd_size, guint tstamp[2], guint timeout_ms, GError **error) @@ -399,7 +399,7 @@ end: * * Returns: TRUE if the overall operation finishes successfully, otherwise FALSE. * - * Since: 3.0. + * Since: 3.0 */ gboolean hinawa_fw_fcp_avc_transaction(HinawaFwFcp *self, const guint8 *cmd, gsize cmd_size, guint8 **resp, gsize *resp_size, guint timeout_ms, @@ -439,7 +439,7 @@ gboolean hinawa_fw_fcp_avc_transaction(HinawaFwFcp *self, const guint8 *cmd, gsi * caller should expand the timeout in advance for the case. * * Returns: TRUE if the overall operation finishes successfully, otherwise FALSE. - * Since: 2.6. + * Since: 2.6 */ gboolean hinawa_fw_fcp_avc_transaction_with_tstamp(HinawaFwFcp *self, const guint8 *cmd, gsize cmd_size, guint8 **resp, gsize *resp_size, @@ -508,7 +508,7 @@ gboolean hinawa_fw_fcp_bind(HinawaFwFcp *self, HinawaFwNode *node, GError **erro * * Stop to listen to FCP responses. * - * Since: 1.4. + * Since: 1.4 */ void hinawa_fw_fcp_unbind(HinawaFwFcp *self) { diff --git a/src/fw_node.c b/src/fw_node.c index f379068..8c2db92 100644 --- a/src/fw_node.c +++ b/src/fw_node.c @@ -16,7 +16,7 @@ * application of Linux FireWire subsystem. All of operations utilize ioctl(2) with subsystem * specific request commands. * - * Since: 1.4. + * Since: 1.4 */ // 256 comes from an actual implementation in kernel land. Read @@ -291,7 +291,7 @@ static void hinawa_fw_node_init(HinawaFwNode *self) * Instantiate [class@FwNode] object and return the instance. * * Returns: an instance of [class@FwNode]. - * Since: 1.4. + * Since: 1.4 */ HinawaFwNode *hinawa_fw_node_new(void) { @@ -341,7 +341,7 @@ static int update_info(HinawaFwNode *self) * * Returns: TRUE if the overall operation finishes successfully, otherwise FALSE. * - * Since: 3.0. + * Since: 3.0 */ gboolean hinawa_fw_node_open(HinawaFwNode *self, const gchar *path, gint open_flag, GError **error) { @@ -402,7 +402,7 @@ gboolean hinawa_fw_node_open(HinawaFwNode *self, const gchar *path, gint open_fl * * Returns: TRUE if the overall operation finishes successfully, otherwise FALSE. * - * Since: 3.0. + * Since: 3.0 */ gboolean hinawa_fw_node_get_config_rom(HinawaFwNode *self, const guint8 **image, gsize *length, GError **error) @@ -442,7 +442,7 @@ gboolean hinawa_fw_node_get_config_rom(HinawaFwNode *self, const guint8 **image, * * Returns: TRUE if the overall operation finishes successfully, otherwise FALSE. * - * Since: 2.6. + * Since: 2.6 */ gboolean hinawa_fw_node_read_cycle_time(HinawaFwNode *self, gint clock_id, HinawaCycleTime *const *cycle_time, GError **error) @@ -581,7 +581,7 @@ static void finalize_src(GSource *gsrc) * * Returns: TRUE if the overall operation finishes successfully, otherwise FALSE. * - * Since: 3.0. + * Since: 3.0 */ gboolean hinawa_fw_node_create_source(HinawaFwNode *self, GSource **gsrc, GError **error) { diff --git a/src/fw_node.h b/src/fw_node.h index 5bb7505..f6bf192 100644 --- a/src/fw_node.h +++ b/src/fw_node.h @@ -23,7 +23,7 @@ struct _HinawaFwNodeClass { * * Class closure for the [signal@FwNode::bus-update]. * - * Since: 1.4. + * Since: 1.4 */ void (*bus_update)(HinawaFwNode *self); @@ -33,7 +33,7 @@ struct _HinawaFwNodeClass { * * Class closure for the [signal@FwNode::disconnected]. * - * Since: 1.4. + * Since: 1.4 */ void (*disconnected)(HinawaFwNode *self); diff --git a/src/fw_req.c b/src/fw_req.c index c5cd110..95a8820 100644 --- a/src/fw_req.c +++ b/src/fw_req.c @@ -107,7 +107,7 @@ static void hinawa_fw_req_init(HinawaFwReq *self) * Instantiate [class@FwReq] object and return the instance. * * Returns: an instance of [class@FwReq]. - * Since: 1.3. + * Since: 1.3 */ HinawaFwReq *hinawa_fw_req_new(void) { @@ -203,7 +203,7 @@ static gboolean initiate_transaction(HinawaFwReq *self, HinawaFwNode *node, Hina * response subaction arrives and running event dispatcher reads the contents, * [signal@FwReq::responded2] signal handler is called. * - * Since: 2.6. + * Since: 2.6 */ gboolean hinawa_fw_req_request(HinawaFwReq *self, HinawaFwNode *node, HinawaFwTcode tcode, guint64 addr, gsize length, guint8 *const *frame, gsize *frame_size, diff --git a/src/fw_resp.c b/src/fw_resp.c index df060f3..2464318 100644 --- a/src/fw_resp.c +++ b/src/fw_resp.c @@ -208,7 +208,7 @@ static void hinawa_fw_resp_init(HinawaFwResp *self) * Instantiate [class@FwResp] object and return the instance. * * Returns: a new instance of [class@FwResp]. - * Since: 1.3. + * Since: 1.3 */ HinawaFwResp *hinawa_fw_resp_new(void) { @@ -231,7 +231,7 @@ HinawaFwResp *hinawa_fw_resp_new(void) * * Returns: TRUE if the overall operation finishes successfully, otherwise FALSE. * - * Since: 3.0. + * Since: 3.0 */ gboolean hinawa_fw_resp_reserve_within_region(HinawaFwResp *self, HinawaFwNode *node, guint64 region_start, guint64 region_end, @@ -295,7 +295,7 @@ gboolean hinawa_fw_resp_reserve_within_region(HinawaFwResp *self, HinawaFwNode * * * Returns: TRUE if the overall operation finishes successfully, otherwise FALSE. * - * Since: 3.0. + * Since: 3.0 */ gboolean hinawa_fw_resp_reserve(HinawaFwResp *self, HinawaFwNode *node, guint64 addr, guint width, GError **error) @@ -309,7 +309,7 @@ gboolean hinawa_fw_resp_reserve(HinawaFwResp *self, HinawaFwNode *node, guint64 * * stop to listen to a range of address in local node (e.g. OHCI 1394 controller). * - * Since: 1.4. + * Since: 1.4 */ void hinawa_fw_resp_release(HinawaFwResp *self) { |