[PATCH v2 16/34] docs: manual: functions: add Since metadata
Victor Toso
victortoso at redhat.com
Thu Apr 14 20:47:27 UTC 2022
This commit finishes the script work and adds docstring to types
that are not documented.
>From this commit onwards, all exported functions are versioned.
Further commits will enforce that it stays like that with new
additions.
Signed-off-by: Victor Toso <victortoso at redhat.com>
---
src/libvirt-domain.c | 3 +++
src/libvirt-network.c | 12 ++++++++++++
src/libvirt-nwfilter.c | 9 +++++++++
src/libvirt-storage.c | 3 +++
4 files changed, 27 insertions(+)
diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c
index b9c0a65cfa..76b4b7e67d 100644
--- a/src/libvirt-domain.c
+++ b/src/libvirt-domain.c
@@ -409,6 +409,9 @@ virDomainLookupByUUID(virConnectPtr conn, const unsigned char *uuid)
*
* Returns a new domain object or NULL in case of failure. If the
* domain cannot be found, then VIR_ERR_NO_DOMAIN error is raised.
+ *
+ * Since: v1.0.0
+ *
*/
virDomainPtr
virDomainLookupByUUIDString(virConnectPtr conn, const char *uuidstr)
diff --git a/src/libvirt-network.c b/src/libvirt-network.c
index eae005e91f..e03f1f0910 100644
--- a/src/libvirt-network.c
+++ b/src/libvirt-network.c
@@ -470,6 +470,9 @@ virNetworkCreateXML(virConnectPtr conn, const char *xmlDesc)
* network object is no longer needed.
*
* Returns a new network object or NULL in case of failure
+ *
+ * Since: v7.8.0
+ *
*/
virNetworkPtr
virNetworkCreateXMLFlags(virConnectPtr conn, const char *xmlDesc, unsigned int flags)
@@ -554,6 +557,9 @@ virNetworkDefineXML(virConnectPtr conn, const char *xml)
* network object is no longer needed.
*
* Returns NULL in case of error, a pointer to the network otherwise
+ *
+ * Since: v7.7.0
+ *
*/
virNetworkPtr
virNetworkDefineXMLFlags(virConnectPtr conn, const char *xml, unsigned int flags)
@@ -640,6 +646,9 @@ virNetworkUndefine(virNetworkPtr network)
* running state, its persistent configuration, or both.
*
* Returns 0 in case of success, -1 in case of error
+ *
+ * Since: v1.0.0
+ *
*/
int
virNetworkUpdate(virNetworkPtr network,
@@ -1776,6 +1785,9 @@ virNetworkPortGetUUID(virNetworkPortPtr port,
* UUID see RFC4122.
*
* Returns -1 in case of error, 0 in case of success
+ *
+ * Since: v5.5.0
+ *
*/
int
virNetworkPortGetUUIDString(virNetworkPortPtr port,
diff --git a/src/libvirt-nwfilter.c b/src/libvirt-nwfilter.c
index 1204d2fdbe..17eed96c0a 100644
--- a/src/libvirt-nwfilter.c
+++ b/src/libvirt-nwfilter.c
@@ -455,6 +455,9 @@ virNWFilterDefineXML(virConnectPtr conn, const char *xmlDesc)
* nwfilter object is no longer needed.
*
* Returns a new nwfilter object or NULL in case of failure
+ *
+ * Since: v7.7.0
+ *
*/
virNWFilterPtr
virNWFilterDefineXMLFlags(virConnectPtr conn, const char *xmlDesc, unsigned int flags)
@@ -616,6 +619,9 @@ virNWFilterRef(virNWFilterPtr nwfilter)
* have an extra allocated element set to NULL but not included in the return count,
* to make iteration easier. The caller is responsible for calling
* virNWFilterFree() on each array element, then calling free() on @filters.
+ *
+ * Since: v4.5.0
+ *
*/
int
virConnectListAllNWFilterBindings(virConnectPtr conn,
@@ -875,6 +881,9 @@ virNWFilterBindingDelete(virNWFilterBindingPtr binding)
*
* Returns a 0 terminated UTF-8 encoded XML instance, or NULL in case
* of error. The caller must free() the returned value.
+ *
+ * Since: v4.5.0
+ *
*/
char *
virNWFilterBindingGetXMLDesc(virNWFilterBindingPtr binding, unsigned int flags)
diff --git a/src/libvirt-storage.c b/src/libvirt-storage.c
index 33b7ff8c39..bf819d9268 100644
--- a/src/libvirt-storage.c
+++ b/src/libvirt-storage.c
@@ -466,6 +466,9 @@ virStoragePoolLookupByUUID(virConnectPtr conn,
* storage pool object is no longer needed.
*
* Returns a virStoragePoolPtr object, or NULL if no matching pool is found
+ *
+ * Since: v1.0.0
+ *
*/
virStoragePoolPtr
virStoragePoolLookupByUUIDString(virConnectPtr conn,
--
2.35.1
More information about the libvir-list
mailing list