[Libosinfo] [libosinfo PATCH 17/20] Add "Since: 1.3.0" to the documentation
Fabiano Fidêncio
fidencio at redhat.com
Mon Jul 15 13:01:55 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_image.c | 8 ++++++++
osinfo/osinfo_imagelist.c | 2 ++
osinfo/osinfo_install_script.c | 8 ++++++++
osinfo/osinfo_install_script.h | 1 +
osinfo/osinfo_loader.c | 2 ++
osinfo/osinfo_media.c | 2 ++
osinfo/osinfo_os.c | 14 ++++++++++++++
osinfo/osinfo_tree.c | 2 ++
8 files changed, 39 insertions(+)
diff --git a/osinfo/osinfo_image.c b/osinfo/osinfo_image.c
index 621ebf0..05115a7 100644
--- a/osinfo/osinfo_image.c
+++ b/osinfo/osinfo_image.c
@@ -230,6 +230,8 @@ OsinfoImage *osinfo_image_new(const gchar *id,
* Retrieves the target hardware architecture of the OS @image provides.
*
* Returns: (transfer none): the hardware architecture, or NULL
+ *
+ * Since: 1.3.0
*/
const gchar *osinfo_image_get_architecture(OsinfoImage *image)
{
@@ -244,6 +246,8 @@ const gchar *osinfo_image_get_architecture(OsinfoImage *image)
* The format of the @image
*
* Returns: (transfer none): the format, or NULL
+ *
+ * Since: 1.3.0
*/
const gchar *osinfo_image_get_format(OsinfoImage *image)
{
@@ -258,6 +262,8 @@ const gchar *osinfo_image_get_format(OsinfoImage *image)
* The URL to the @image
*
* Returns: (transfer none): the URL, or NULL
+ *
+ * Since: 1.3.0
*/
const gchar *osinfo_image_get_url(OsinfoImage *image)
{
@@ -273,6 +279,8 @@ const gchar *osinfo_image_get_url(OsinfoImage *image)
*
* Returns: #TRUE if @image supports cloud init customizations, #FALSE
* otherwise.
+ *
+ * Since: 1.3.0
*/
gboolean osinfo_image_get_cloud_init(OsinfoImage *image)
{
diff --git a/osinfo/osinfo_imagelist.c b/osinfo/osinfo_imagelist.c
index 0187b89..0f822a8 100644
--- a/osinfo/osinfo_imagelist.c
+++ b/osinfo/osinfo_imagelist.c
@@ -73,6 +73,8 @@ osinfo_imagelist_init(OsinfoImageList *list)
* Construct a new image list that is initially empty.
*
* Returns: (transfer full): an empty image list
+ *
+ * Since: 1.3.0
*/
OsinfoImageList *osinfo_imagelist_new(void)
{
diff --git a/osinfo/osinfo_install_script.c b/osinfo/osinfo_install_script.c
index 3d8c502..b96e134 100644
--- a/osinfo/osinfo_install_script.c
+++ b/osinfo/osinfo_install_script.c
@@ -1961,6 +1961,8 @@ gboolean osinfo_install_script_get_needs_internet(OsinfoInstallScript *script)
* OSINFO_INSTALL_SCRIPT_INJECTION_METHOD_WEB
*
* Set the preferred injection method to be used with the @script
+ *
+ * Since: 1.3.0
*/
void osinfo_install_script_set_preferred_injection_method(OsinfoInstallScript *script,
OsinfoInstallScriptInjectionMethod method)
@@ -1988,6 +1990,8 @@ void osinfo_install_script_set_preferred_injection_method(OsinfoInstallScript *s
* OSINFO_INSTALL_SCRIPT_INJECTION_METHOD_DISK is supported,
* OSINFO_INSTALL_SCRIPT_INJECTION_METHOD_DISK is returned, otherwise
* OSINFO_INSTALL_SCRIPT_INJECTION_METHOD_INITRD is returned.
+ *
+ * Since: 1.3.0
*/
OsinfoInstallScriptInjectionMethod
osinfo_install_script_get_preferred_injection_method(OsinfoInstallScript *script)
@@ -2025,6 +2029,8 @@ osinfo_install_script_get_preferred_injection_method(OsinfoInstallScript *script
* OSINFO_INSTALL_SCRIPT_INSTALLATION_SOURCE_NETWORK
*
* Set the installation source to be used with the @script.
+ *
+ * Since: 1.3.0
*/
void osinfo_install_script_set_installation_source(OsinfoInstallScript *script,
OsinfoInstallScriptInstallationSource source)
@@ -2041,6 +2047,8 @@ void osinfo_install_script_set_installation_source(OsinfoInstallScript *script,
*
* Returns: the installation source to be used with the script. If none is set, it defaults to
* OSINFO_INSTALL_SCRIPT_INSTALLATION_SOURCE_MEDIA.
+ *
+ * Since: 1.3.0
*/
OsinfoInstallScriptInstallationSource
osinfo_install_script_get_installation_source(OsinfoInstallScript *script)
diff --git a/osinfo/osinfo_install_script.h b/osinfo/osinfo_install_script.h
index ccd6cbc..626e66c 100644
--- a/osinfo/osinfo_install_script.h
+++ b/osinfo/osinfo_install_script.h
@@ -140,6 +140,7 @@ typedef enum {
/**
* OsinfoInstallScriptInstallationSource:
+ * Since: 1.3.0
* @OSINFO_INSTALL_SCRIPT_INSTALLATION_SOURCE_MEDIA: A media will be used as
* the installation source.
* @OSINFO_INSTALL_SCRIPT_INSTALLATION_SOURCE_NETWORK: A network method will
diff --git a/osinfo/osinfo_loader.c b/osinfo/osinfo_loader.c
index 6d1c801..51bd8ac 100644
--- a/osinfo/osinfo_loader.c
+++ b/osinfo/osinfo_loader.c
@@ -151,6 +151,8 @@ OsinfoLoader *osinfo_loader_new(void)
* Gets a #GQuark representing the string "libosinfo"
*
* Returns: the #GQuark representing the string.
+ *
+ * Since: 1.3.0
**/
GQuark
osinfo_error_quark(void)
diff --git a/osinfo/osinfo_media.c b/osinfo/osinfo_media.c
index b8b53a7..9b693f6 100644
--- a/osinfo/osinfo_media.c
+++ b/osinfo/osinfo_media.c
@@ -1764,6 +1764,8 @@ gboolean osinfo_media_get_eject_after_install(OsinfoMedia *media)
*
* Returns: #TRUE if install-scripts are supported by the media,
* #FALSE otherwise
+ *
+ * Since: 1.3.0
*/
gboolean osinfo_media_supports_installer_script(OsinfoMedia *media)
{
diff --git a/osinfo/osinfo_os.c b/osinfo/osinfo_os.c
index 7c69bfb..083488e 100644
--- a/osinfo/osinfo_os.c
+++ b/osinfo/osinfo_os.c
@@ -552,6 +552,8 @@ osinfo_os_get_all_device_links_internal(OsinfoOs *os,
* derived and cloned operating systems.
*
* Returns: (transfer full): A list of OsinfoDeviceLink
+ *
+ * Since: 1.3.0
*/
OsinfoDeviceLinkList *osinfo_os_get_all_device_links(OsinfoOs *os, OsinfoFilter *filter)
{
@@ -711,6 +713,8 @@ void osinfo_os_add_tree(OsinfoOs *os, OsinfoTree *tree)
* Get all installed images associated with operating system @os.
*
* Returns: (transfer full): A list of images
+ *
+ * Since: 1.3.0
*/
OsinfoImageList *osinfo_os_get_image_list(OsinfoOs *os)
{
@@ -729,6 +733,8 @@ OsinfoImageList *osinfo_os_get_image_list(OsinfoOs *os)
* @image: (transfer none): the image to add
*
* Adds an installed image @image to operating system @os.
+ *
+ * Since: 1.3.0
*/
void osinfo_os_add_image(OsinfoOs *os, OsinfoImage *image)
{
@@ -942,6 +948,8 @@ osinfo_os_get_maximum_resources_without_inheritance(OsinfoOs *os)
* Get the list of maximum resources for the operating system @os.
*
* Returns: (transfer full): A list of resources
+ *
+ * Since: 1.3.0
*/
OsinfoResourcesList *osinfo_os_get_maximum_resources(OsinfoOs *os)
{
@@ -1018,6 +1026,8 @@ osinfo_os_get_network_install_resources_without_inheritance(OsinfoOs *os)
* @os.
*
* Returns: (transfer full): A list of resources
+ *
+ * Since: 1.3.0
*/
OsinfoResourcesList *osinfo_os_get_network_install_resources(OsinfoOs *os)
{
@@ -1063,6 +1073,8 @@ void osinfo_os_add_recommended_resources(OsinfoOs *os,
* @resources: (transfer none): the resources to add
*
* Adds @resources to list of maximum resources of operating system @os.
+ *
+ * Since: 1.3.0
*/
void osinfo_os_add_maximum_resources(OsinfoOs *os,
OsinfoResources *resources)
@@ -1081,6 +1093,8 @@ void osinfo_os_add_maximum_resources(OsinfoOs *os,
*
* Adds @resources to list of resources needed for network installing an
* operating system @os.
+ *
+ * Since: 1.3.0
*/
void osinfo_os_add_network_install_resources(OsinfoOs *os,
OsinfoResources *resources)
diff --git a/osinfo/osinfo_tree.c b/osinfo/osinfo_tree.c
index f804e46..98f2334 100644
--- a/osinfo/osinfo_tree.c
+++ b/osinfo/osinfo_tree.c
@@ -947,6 +947,8 @@ const gchar *osinfo_tree_get_initrd_path(OsinfoTree *tree)
* Return whether a tree has treeinfo or not.
*
* Returns: TRUE if the tree has treeinfo. FALSE otherwise.
+ *
+ * Since: 1.3.0
*/
gboolean osinfo_tree_has_treeinfo(OsinfoTree *tree)
{
--
2.21.0
More information about the Libosinfo
mailing list