aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTakashi Sakamoto <o-takashi@sakamocchi.jp>2022-05-03 07:57:47 +0900
committer坂本 貴史 <o-takashi@sakamocchi.jp>2022-05-03 08:31:29 +0900
commit24bf97abeb8bb8fe578a96b7b16c34cb2a2d049f (patch)
tree1680219192175ccd481874f7095a36284c5b51ef
parent76dea57853eabd6c86a0382f43d26f869cff009d (diff)
downloadlibhinoko-24bf97abeb8bb8fe578a96b7b16c34cb2a2d049f.tar.gz
update README
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
-rw-r--r--README.rst7
-rw-r--r--src/fw_iso_resource.h4
-rw-r--r--src/hinoko_enum_types.h2
3 files changed, 8 insertions, 5 deletions
diff --git a/README.rst b/README.rst
index 8b1f86d..7b5dc97 100644
--- a/README.rst
+++ b/README.rst
@@ -2,7 +2,7 @@
libhinoko
=========
-2022/04/18
+2022/05/02
Takashi Sakamoto
Introduction
@@ -77,7 +77,7 @@ You can see documentation files under ``(directory-to-install)/share/doc/hinoko/
Loss of backward compatibility between v0.6/v0.7 releases
=========================================================
-The status of project is still under development. Below public functions are removed since v0.7
+The status of project is still under development. Below public functions are removed at v0.7
release without backward compatibility:
- ``Hinoko.FwIsoResource.allocate_once_async``
@@ -98,6 +98,9 @@ wait for event:
- ``Hinoko.FwIsoResourceAuto.allocate_sync``
- ``Hinoko.FwIsoResourceAuto.deallocate_sync``
+Furthermore, ``Hinoko.FwIsoResource`` becomes GObject interface. ``Hinoko.FwIsoResourceAuto`` and
+``Hinoko.FwIsoResourceOnce`` implements the interface.
+
Loss of backward compatibility between v0.5/v0.6 releases
=========================================================
diff --git a/src/fw_iso_resource.h b/src/fw_iso_resource.h
index 33e8f8e..a19e8d6 100644
--- a/src/fw_iso_resource.h
+++ b/src/fw_iso_resource.h
@@ -24,7 +24,7 @@ struct _HinokoFwIsoResourceInterface {
/**
* HinokoFwIsoResourceClass::allocated:
- * @self: A [class@FwIsoResource].
+ * @self: A [iface@FwIsoResource].
* @channel: The deallocated channel number.
* @bandwidth: The deallocated amount of bandwidth.
* @error: (transfer none) (nullable) (in): A [struct@GLib.Error]. Error can be generated
@@ -39,7 +39,7 @@ struct _HinokoFwIsoResourceInterface {
/**
* HinokoFwIsoResourceClass::deallocated:
- * @self: A [class@FwIsoResource].
+ * @self: A [iface@FwIsoResource].
* @channel: The deallocated channel number.
* @bandwidth: The deallocated amount of bandwidth.
* @error: (transfer none) (nullable) (in): A [struct@GLib.Error]. Error can be generated
diff --git a/src/hinoko_enum_types.h b/src/hinoko_enum_types.h
index 1585392..69437f4 100644
--- a/src/hinoko_enum_types.h
+++ b/src/hinoko_enum_types.h
@@ -65,7 +65,7 @@ typedef enum /*< flags >*/
* @HINOKO_FW_ISO_RESOURCE_ERROR_TIMEOUT: No event to the request arrives within timeout.
* @HINOKO_FW_ISO_RESOURCE_ERROR_EVENT: Event for the request arrives but includes error code.
*
- * A set of error code for [class@FwIsoResource].
+ * A set of error code for [iface@FwIsoResource].
*/
typedef enum {
HINOKO_FW_ISO_RESOURCE_ERROR_FAILED,