[Libosinfo] [libosinfo PATCH 09/20] Add "Since: 0.2.6" to the documentation

Fabiano Fidêncio fidencio at redhat.com
Mon Jul 15 13:01:47 UTC 2019


Let's add the "Since: ..." information as part of the function's
documentation. It helps developers reading our docs to easily figure out
when a function has been introduced.

Signed-off-by: Fabiano Fidêncio <fidencio at redhat.com>
---
 osinfo/osinfo_device_driver.c  | 2 ++
 osinfo/osinfo_install_config.c | 4 ++++
 osinfo/osinfo_install_script.c | 4 ++++
 osinfo/osinfo_install_script.h | 1 +
 4 files changed, 11 insertions(+)

diff --git a/osinfo/osinfo_device_driver.c b/osinfo/osinfo_device_driver.c
index 04ab5d8..a0e6222 100644
--- a/osinfo/osinfo_device_driver.c
+++ b/osinfo/osinfo_device_driver.c
@@ -188,6 +188,8 @@ void osinfo_device_driver_add_device(OsinfoDeviceDriver *driver,
  * before these device drivers could be installed on their OS.
  *
  * Returns: TRUE if @driver is signed, FALSE otherwise.
+ *
+ * Since: 0.2.6
  */
 gboolean osinfo_device_driver_get_signed(OsinfoDeviceDriver *driver)
 {
diff --git a/osinfo/osinfo_install_config.c b/osinfo/osinfo_install_config.c
index 05eff36..2bd5e4b 100644
--- a/osinfo/osinfo_install_config.c
+++ b/osinfo/osinfo_install_config.c
@@ -882,6 +882,8 @@ const gchar *osinfo_install_config_get_post_install_drivers_location(OsinfoInsta
  * If a script requires drivers to be signed, this function can be used to
  * disable that security feature. WARNING: Disabling driver signing may very
  * well mean disabling it permanently.
+ *
+ * Since: 0.2.6
  */
 void osinfo_install_config_set_driver_signing(OsinfoInstallConfig *config,
                                               gboolean signing)
@@ -898,6 +900,8 @@ void osinfo_install_config_set_driver_signing(OsinfoInstallConfig *config,
  * Returns: %TRUE if driver signing is currently enabled, %FALSE otherwise, see
  * #osinfo_install_config_set_driver_signing() for more details about driver
  * signing.
+ *
+ * Since: 0.2.6
  */
 gboolean osinfo_install_config_get_driver_signing(OsinfoInstallConfig *config)
 {
diff --git a/osinfo/osinfo_install_script.c b/osinfo/osinfo_install_script.c
index 934f25c..826b9e2 100644
--- a/osinfo/osinfo_install_script.c
+++ b/osinfo/osinfo_install_script.c
@@ -1868,6 +1868,8 @@ gboolean osinfo_install_script_get_can_post_install_drivers(OsinfoInstallScript
  * this function retrieves the requirement about signed status of drivers.
  *
  * Returns: (type OsinfoDeviceDriverSigningReq):
+ *
+ * Since: 0.2.6
  */
 int osinfo_install_script_get_pre_install_drivers_signing_req(OsinfoInstallScript *script)
 {
@@ -1886,6 +1888,8 @@ int osinfo_install_script_get_pre_install_drivers_signing_req(OsinfoInstallScrip
  * function retrieves the requirement about signed status of drivers.
  *
  * Returns: (type OsinfoDeviceDriverSigningReq):
+ *
+ * Since: 0.2.6
  */
 int osinfo_install_script_get_post_install_drivers_signing_req(OsinfoInstallScript *script)
 {
diff --git a/osinfo/osinfo_install_script.h b/osinfo/osinfo_install_script.h
index e8abe25..f3fa5ba 100644
--- a/osinfo/osinfo_install_script.h
+++ b/osinfo/osinfo_install_script.h
@@ -95,6 +95,7 @@ typedef enum {
 
 /**
  * OsinfoDeviceDriverSigningReq:
+ * Since: 0.2.6
  * @OSINFO_DEVICE_DRIVER_SIGNING_REQ_NONE: Script do not require device drivers
  * to be signed.
  * @OSINFO_DEVICE_DRIVER_SIGNING_REQ_STRICT: Script must only be given signed
-- 
2.21.0




More information about the Libosinfo mailing list