aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTakashi Sakamoto <o-takashi@sakamocchi.jp>2023-07-23 13:51:42 +0900
committerTakashi Sakamoto <o-takashi@sakamocchi.jp>2023-07-23 13:51:56 +0900
commitf1579a7cf54940321e5f72c2392138819caa0228 (patch)
treefb5cecf7f270e7eb8530e93ad695abd80c43900b
parentbae604032b3afa01416b00fd6a5dcb57cdac304a (diff)
downloadlibhinoko-f1579a7cf54940321e5f72c2392138819caa0228.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/fw_iso_ctx.c18
-rw-r--r--src/fw_iso_ctx.h12
-rw-r--r--src/fw_iso_ir_multiple.c2
-rw-r--r--src/fw_iso_ir_single.c10
-rw-r--r--src/fw_iso_it.c8
-rw-r--r--src/fw_iso_resource.c16
-rw-r--r--src/fw_iso_resource.h10
-rw-r--r--src/fw_iso_resource_auto.c10
-rw-r--r--src/fw_iso_resource_once.c4
9 files changed, 45 insertions, 45 deletions
diff --git a/src/fw_iso_ctx.c b/src/fw_iso_ctx.c
index 42df6c9..7aee512 100644
--- a/src/fw_iso_ctx.c
+++ b/src/fw_iso_ctx.c
@@ -70,7 +70,7 @@ static void hinoko_fw_iso_ctx_default_init(HinokoFwIsoCtxInterface *iface)
*
* The number of bytes per chunk in buffer.
*
- * Since: 0.7.
+ * Since: 0.7
*/
g_object_interface_install_property(iface,
g_param_spec_uint(BYTES_PER_CHUNK_PROP_NAME, "bytes-per-chunk",
@@ -83,7 +83,7 @@ static void hinoko_fw_iso_ctx_default_init(HinokoFwIsoCtxInterface *iface)
*
* The number of chunks per buffer.
*
- * Since: 0.7.
+ * Since: 0.7
*/
g_object_interface_install_property(iface,
g_param_spec_uint(CHUNKS_PER_BUFFER_PROP_NAME, "chunks-per-buffer",
@@ -98,7 +98,7 @@ static void hinoko_fw_iso_ctx_default_init(HinokoFwIsoCtxInterface *iface)
*
* Emitted when isochronous context is stopped.
*
- * Since: 0.7.
+ * Since: 0.7
*/
g_signal_new(STOPPED_SIGNAL_NAME,
G_TYPE_FROM_INTERFACE(iface),
@@ -122,7 +122,7 @@ static void hinoko_fw_iso_ctx_default_init(HinokoFwIsoCtxInterface *iface)
*
* Returns: TRUE if the overall operation finishes successfully, otherwise FALSE.
*
- * Since: 0.9.
+ * Since: 0.9
*/
gboolean hinoko_fw_iso_ctx_read_cycle_time(HinokoFwIsoCtx *self, gint clock_id,
HinawaCycleTime *const *cycle_time, GError **error)
@@ -145,7 +145,7 @@ gboolean hinoko_fw_iso_ctx_read_cycle_time(HinokoFwIsoCtx *self, gint clock_id,
*
* Returns: TRUE if the overall operation finishes successfully, otherwise FALSE.
*
- * Since: 0.7.
+ * Since: 0.7
*/
gboolean hinoko_fw_iso_ctx_create_source(HinokoFwIsoCtx *self, GSource **source, GError **error)
{
@@ -162,7 +162,7 @@ gboolean hinoko_fw_iso_ctx_create_source(HinokoFwIsoCtx *self, GSource **source,
*
* Stop isochronous context.
*
- * Since: 0.7.
+ * Since: 0.7
*/
void hinoko_fw_iso_ctx_stop(HinokoFwIsoCtx *self)
{
@@ -177,7 +177,7 @@ void hinoko_fw_iso_ctx_stop(HinokoFwIsoCtx *self)
*
* Unmap intermediate buffer shared with 1394 OHCI controller for the context.
*
- * Since: 0.7.
+ * Since: 0.7
*/
void hinoko_fw_iso_ctx_unmap_buffer(HinokoFwIsoCtx *self)
{
@@ -193,7 +193,7 @@ void hinoko_fw_iso_ctx_unmap_buffer(HinokoFwIsoCtx *self)
*
* Release the contest from 1394 OHCI controller.
*
- * Since: 0.7.
+ * Since: 0.7
*/
void hinoko_fw_iso_ctx_release(HinokoFwIsoCtx *self)
{
@@ -214,7 +214,7 @@ void hinoko_fw_iso_ctx_release(HinokoFwIsoCtx *self)
*
* Returns: TRUE if the overall operation finishes successfully, otherwise FALSE.
*
- * Since: 0.7.
+ * Since: 0.7
*/
gboolean hinoko_fw_iso_ctx_flush_completions(HinokoFwIsoCtx *self, GError **error)
{
diff --git a/src/fw_iso_ctx.h b/src/fw_iso_ctx.h
index 25c6e58..c663e62 100644
--- a/src/fw_iso_ctx.h
+++ b/src/fw_iso_ctx.h
@@ -23,7 +23,7 @@ struct _HinokoFwIsoCtxInterface {
*
* Virtual function to stop isochronous context.
*
- * Since: 0.7.
+ * Since: 0.7
*/
void (*stop)(HinokoFwIsoCtx *self);
@@ -34,7 +34,7 @@ struct _HinokoFwIsoCtxInterface {
* Virtual function to unmap intermediate buffer shared with 1394 OHCI controller for the
* context.
*
- * Since: 0.7.
+ * Since: 0.7
*/
void (*unmap_buffer)(HinokoFwIsoCtx *self);
@@ -44,7 +44,7 @@ struct _HinokoFwIsoCtxInterface {
*
* Virtual function to release the contest from 1394 OHCI controller.
*
- * Since: 0.7.
+ * Since: 0.7
*/
void (*release)(HinokoFwIsoCtx *self);
@@ -61,7 +61,7 @@ struct _HinokoFwIsoCtxInterface {
*
* Returns: TRUE if the overall operation finishes successfully, otherwise FALSE.
*
- * Since: 0.9.
+ * Since: 0.9
*/
gboolean (*read_cycle_time)(HinokoFwIsoCtx *self, gint clock_id,
HinawaCycleTime *const *cycle_time, GError **error);
@@ -78,7 +78,7 @@ struct _HinokoFwIsoCtxInterface {
*
* Returns: TRUE if the overall operation finishes successfully, otherwise FALSE.
*
- * Since: 0.7.
+ * Since: 0.7
*/
gboolean (*flush_completions)(HinokoFwIsoCtx *self, GError **error);
@@ -93,7 +93,7 @@ struct _HinokoFwIsoCtxInterface {
*
* Returns: TRUE if the overall operation finishes successfully, otherwise FALSE.
*
- * Since: 0.7.
+ * Since: 0.7
*/
gboolean (*create_source)(HinokoFwIsoCtx *self, GSource **source, GError **error);
diff --git a/src/fw_iso_ir_multiple.c b/src/fw_iso_ir_multiple.c
index 2d3ec0e..881bab1 100644
--- a/src/fw_iso_ir_multiple.c
+++ b/src/fw_iso_ir_multiple.c
@@ -498,7 +498,7 @@ gboolean hinoko_fw_iso_ir_multiple_start(HinokoFwIsoIrMultiple *self, const guin
* Retrieve data for packet indicated by the index parameter. The data has isochronous packet header
* in its first quadlet, timestamp in its last quadlet. The rest is data of isochronous packet.
*
- * Since: 0.7.
+ * Since: 0.7
*/
void hinoko_fw_iso_ir_multiple_get_payload(HinokoFwIsoIrMultiple *self, guint index,
const guint8 **payload, guint *length)
diff --git a/src/fw_iso_ir_single.c b/src/fw_iso_ir_single.c
index eeb9e7b..8cb46ee 100644
--- a/src/fw_iso_ir_single.c
+++ b/src/fw_iso_ir_single.c
@@ -256,7 +256,7 @@ HinokoFwIsoIrSingle *hinoko_fw_iso_ir_single_new(void)
*
* Returns: TRUE if the overall operation finishes successfully, otherwise FALSE.
*
- * Since: 0.7.
+ * Since: 0.7
*/
gboolean hinoko_fw_iso_ir_single_allocate(HinokoFwIsoIrSingle *self, const char *path,
guint channel, guint header_size, GError **error)
@@ -290,7 +290,7 @@ gboolean hinoko_fw_iso_ir_single_allocate(HinokoFwIsoIrSingle *self, const char
*
* Returns: TRUE if the overall operation finishes successfully, otherwise FALSE.
*
- * Since: 0.7.
+ * Since: 0.7
*/
gboolean hinoko_fw_iso_ir_single_map_buffer(HinokoFwIsoIrSingle *self,
guint maximum_bytes_per_payload,
@@ -319,7 +319,7 @@ gboolean hinoko_fw_iso_ir_single_map_buffer(HinokoFwIsoIrSingle *self,
*
* Returns: TRUE if the overall operation finishes successfully, otherwise FALSE.
*
- * Since: 0.7.
+ * Since: 0.7
*/
gboolean hinoko_fw_iso_ir_single_register_packet(HinokoFwIsoIrSingle *self,
gboolean schedule_interrupt, GError **error)
@@ -348,7 +348,7 @@ gboolean hinoko_fw_iso_ir_single_register_packet(HinokoFwIsoIrSingle *self,
*
* Returns: TRUE if the overall operation finishes successfully, otherwise FALSE.
*
- * Since: 0.7.
+ * Since: 0.7
*/
gboolean hinoko_fw_iso_ir_single_start(HinokoFwIsoIrSingle *self, const guint16 *cycle_match,
guint32 sync_code, HinokoFwIsoCtxMatchFlag tags, GError **error)
@@ -381,7 +381,7 @@ gboolean hinoko_fw_iso_ir_single_start(HinokoFwIsoIrSingle *self, const guint16
* Retrieve payload of IR context for a handled packet corresponding to index at the event of
* interrupt.
*
- * Since: 0.7.
+ * Since: 0.7
*/
void hinoko_fw_iso_ir_single_get_payload(HinokoFwIsoIrSingle *self, guint index,
const guint8 **payload, guint *length)
diff --git a/src/fw_iso_it.c b/src/fw_iso_it.c
index a609314..95f55f3 100644
--- a/src/fw_iso_it.c
+++ b/src/fw_iso_it.c
@@ -234,7 +234,7 @@ HinokoFwIsoIt *hinoko_fw_iso_it_new(void)
*
* Returns: TRUE if the overall operation finishes successful, otherwise FALSE.
*
- * Since: 0.7.
+ * Since: 0.7
*/
gboolean hinoko_fw_iso_it_allocate(HinokoFwIsoIt *self, const char *path, HinokoFwScode scode,
guint channel, guint header_size, GError **error)
@@ -261,7 +261,7 @@ gboolean hinoko_fw_iso_it_allocate(HinokoFwIsoIt *self, const char *path, Hinoko
*
* Returns: TRUE if the overall operation finishes successful, otherwise FALSE.
*
- * Since: 0.7.
+ * Since: 0.7
*/
gboolean hinoko_fw_iso_it_map_buffer(HinokoFwIsoIt *self, guint maximum_bytes_per_payload,
guint payloads_per_buffer, GError **error)
@@ -289,7 +289,7 @@ gboolean hinoko_fw_iso_it_map_buffer(HinokoFwIsoIt *self, guint maximum_bytes_pe
*
* Returns: TRUE if the overall operation finishes successful, otherwise FALSE.
*
- * Since: 0.7.
+ * Since: 0.7
*/
gboolean hinoko_fw_iso_it_start(HinokoFwIsoIt *self, const guint16 *cycle_match, GError **error)
{
@@ -328,7 +328,7 @@ gboolean hinoko_fw_iso_it_start(HinokoFwIsoIt *self, const guint16 *cycle_match,
*
* Returns: TRUE if the overall operation finishes successful, otherwise FALSE.
*
- * Since: 0.7.
+ * Since: 0.7
*/
gboolean hinoko_fw_iso_it_register_packet(HinokoFwIsoIt *self, HinokoFwIsoCtxMatchFlag tags,
guint sync_code,
diff --git a/src/fw_iso_resource.c b/src/fw_iso_resource.c
index f971b32..8977a33 100644
--- a/src/fw_iso_resource.c
+++ b/src/fw_iso_resource.c
@@ -8,7 +8,7 @@
* The [iface@FwIsoResource] should be implemented in GObject-derived object to listen events of
* isochronous resource allocation and deallocation.
*
- * Since: 0.7.
+ * Since: 0.7
*/
G_DEFINE_INTERFACE(HinokoFwIsoResource, hinoko_fw_iso_resource, G_TYPE_OBJECT)
@@ -66,7 +66,7 @@ static void hinoko_fw_iso_resource_default_init(HinokoFwIsoResourceInterface *if
*
* The numeric value of current generation for bus topology.
*
- * Since: 0.7.
+ * Since: 0.7
*/
g_object_interface_install_property(iface,
g_param_spec_uint(GENERATION_PROP_NAME, "generation",
@@ -85,7 +85,7 @@ static void hinoko_fw_iso_resource_default_init(HinokoFwIsoResourceInterface *if
*
* Emitted when allocation of isochronous resource finishes.
*
- * Since: 0.7.
+ * Since: 0.7
*/
g_signal_new(ALLOCATED_SIGNAL_NAME,
G_TYPE_FROM_INTERFACE(iface),
@@ -106,7 +106,7 @@ static void hinoko_fw_iso_resource_default_init(HinokoFwIsoResourceInterface *if
*
* Emitted when deallocation of isochronous resource finishes.
*
- * Since: 0.7.
+ * Since: 0.7
*/
g_signal_new(DEALLOCATED_SIGNAL_NAME,
G_TYPE_FROM_INTERFACE(iface),
@@ -132,7 +132,7 @@ static void hinoko_fw_iso_resource_default_init(HinokoFwIsoResourceInterface *if
*
* Returns: TRUE if the overall operation finished successfully, otherwise FALSE.
*
- * Since: 0.7.
+ * Since: 0.7
*/
gboolean hinoko_fw_iso_resource_open(HinokoFwIsoResource *self, const gchar *path, gint open_flag,
GError **error)
@@ -155,7 +155,7 @@ gboolean hinoko_fw_iso_resource_open(HinokoFwIsoResource *self, const gchar *pat
*
* Returns: TRUE if the overall operation finished successfully, otherwise FALSE.
*
- * Since: 0.7.
+ * Since: 0.7
*/
gboolean hinoko_fw_iso_resource_create_source(HinokoFwIsoResource *self, GSource **source,
GError **error)
@@ -183,7 +183,7 @@ gboolean hinoko_fw_iso_resource_create_source(HinokoFwIsoResource *self, GSource
*
* Returns: TRUE if the overall operation finishes successfully, otherwise FALSE.
*
- * Since: 0.7.
+ * Since: 0.7
*/
gboolean hinoko_fw_iso_resource_allocate_async(HinokoFwIsoResource *self,
const guint8 *channel_candidates,
@@ -217,7 +217,7 @@ gboolean hinoko_fw_iso_resource_allocate_async(HinokoFwIsoResource *self,
*
* Returns: TRUE if the overall operation finishes successfully, otherwise FALSE.
*
- * Since: 0.7.
+ * Since: 0.7
*/
gboolean hinoko_fw_iso_resource_allocate_sync(HinokoFwIsoResource *self,
const guint8 *channel_candidates,
diff --git a/src/fw_iso_resource.h b/src/fw_iso_resource.h
index be34ee8..688709b 100644
--- a/src/fw_iso_resource.h
+++ b/src/fw_iso_resource.h
@@ -30,7 +30,7 @@ struct _HinokoFwIsoResourceInterface {
*
* Returns: TRUE if the overall operation finished successfully, otherwise FALSE.
*
- * Since: 0.7.
+ * Since: 0.7
*/
gboolean (*open)(HinokoFwIsoResource *self, const gchar *path, gint open_flag,
GError **error);
@@ -49,7 +49,7 @@ struct _HinokoFwIsoResourceInterface {
*
* Returns: TRUE if the overall operation finished successfully, otherwise FALSE.
*
- * Since: 0.7.
+ * Since: 0.7
*/
gboolean (*allocate_async)(HinokoFwIsoResource *self, const guint8 *channel_candidates,
gsize channel_candidates_count, guint bandwidth, GError **error);
@@ -65,7 +65,7 @@ struct _HinokoFwIsoResourceInterface {
*
* Returns: TRUE if the overall operation finished successfully, otherwise FALSE.
*
- * Since: 0.7.
+ * Since: 0.7
*/
gboolean (*create_source)(HinokoFwIsoResource *self, GSource **source, GError **error);
@@ -79,7 +79,7 @@ struct _HinokoFwIsoResourceInterface {
*
* Closure for the [signal@FwIsoResource::allocated] signal.
*
- * Since: 0.7.
+ * Since: 0.7
*/
void (*allocated)(HinokoFwIsoResource *self, guint channel,
guint bandwidth, const GError *error);
@@ -94,7 +94,7 @@ struct _HinokoFwIsoResourceInterface {
*
* Closure for the [signal@FwIsoResource::deallocated] signal.
*
- * Since: 0.7.
+ * Since: 0.7
*/
void (*deallocated)(HinokoFwIsoResource *self, guint channel,
guint bandwidth, const GError *error);
diff --git a/src/fw_iso_resource_auto.c b/src/fw_iso_resource_auto.c
index e93c379..f6f8a64 100644
--- a/src/fw_iso_resource_auto.c
+++ b/src/fw_iso_resource_auto.c
@@ -134,7 +134,7 @@ static void hinoko_fw_iso_resource_auto_class_init(HinokoFwIsoResourceAutoClass
*
* Whether to be allocate isochronous resource or not.
*
- * Since: 0.7.
+ * Since: 0.7
*/
g_object_class_install_property(gobject_class, FW_ISO_RESOURCE_AUTO_PROP_IS_ALLOCATED,
g_param_spec_boolean("is-allocated", "is-allocated",
@@ -146,7 +146,7 @@ static void hinoko_fw_iso_resource_auto_class_init(HinokoFwIsoResourceAutoClass
*
* The allocated channel number.
*
- * Since: 0.7.
+ * Since: 0.7
*/
g_object_class_install_property(gobject_class, FW_ISO_RESOURCE_AUTO_PROP_CHANNEL,
g_param_spec_uint("channel", "channel",
@@ -159,7 +159,7 @@ static void hinoko_fw_iso_resource_auto_class_init(HinokoFwIsoResourceAutoClass
*
* The allocated amount of bandwidth.
*
- * Since: 0.7.
+ * Since: 0.7
*/
g_object_class_install_property(gobject_class, FW_ISO_RESOURCE_AUTO_PROP_BANDWIDTH,
g_param_spec_uint("bandwidth", "bandwidth",
@@ -370,7 +370,7 @@ HinokoFwIsoResourceAuto *hinoko_fw_iso_resource_auto_new()
*
* Returns: TRUE if the overall operation finished successfully, otherwise FALSE.
*
- * Since: 0.7.
+ * Since: 0.7
*/
gboolean hinoko_fw_iso_resource_auto_deallocate_async(HinokoFwIsoResourceAuto *self,
GError **error)
@@ -423,7 +423,7 @@ end:
*
* Returns: TRUE if the overall operation finished successfully, otherwise FALSE.
*
- * Since: 0.7.
+ * Since: 0.7
*/
gboolean hinoko_fw_iso_resource_auto_deallocate_sync(HinokoFwIsoResourceAuto *self,
guint timeout_ms, GError **error)
diff --git a/src/fw_iso_resource_once.c b/src/fw_iso_resource_once.c
index 8fa02d8..38d8e17 100644
--- a/src/fw_iso_resource_once.c
+++ b/src/fw_iso_resource_once.c
@@ -215,7 +215,7 @@ HinokoFwIsoResourceOnce *hinoko_fw_iso_resource_once_new()
*
* Returns: TRUE if the overall operation finishes successfully, otherwise FALSE.
*
- * Since: 0.7.
+ * Since: 0.7
*/
gboolean hinoko_fw_iso_resource_once_deallocate_async(HinokoFwIsoResourceOnce *self, guint channel,
guint bandwidth, GError **error)
@@ -260,7 +260,7 @@ gboolean hinoko_fw_iso_resource_once_deallocate_async(HinokoFwIsoResourceOnce *s
*
* Returns: TRUE if the overall operation finishes successfully, otherwise FALSE.
*
- * Since: 0.7.
+ * Since: 0.7
*/
gboolean hinoko_fw_iso_resource_once_deallocate_sync(HinokoFwIsoResourceOnce *self, guint channel,
guint bandwidth, guint timeout_ms,