[PATCH v4 10/19] docstring: typedef: admin:: Add 'Since version' metadata

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Either create or append to existing docstring, the version (git tag)
that a given typedef was introduced in the format:

    Since: v1.2.3

Signed-off-by: Victor Toso <victortoso@xxxxxxxxxx>
---
 include/libvirt/libvirt-admin.h | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/include/libvirt/libvirt-admin.h b/include/libvirt/libvirt-admin.h
index d24067b304..67b17fe0c0 100644
--- a/include/libvirt/libvirt-admin.h
+++ b/include/libvirt/libvirt-admin.h
@@ -37,6 +37,8 @@ extern "C" {
  *
  * a virAdmConnect is a private structure representing a connection to
  * libvirt daemon.
+ *
+ * Since: v2.0.0
  */
 typedef struct _virAdmConnect virAdmConnect;
 
@@ -45,6 +47,8 @@ typedef struct _virAdmConnect virAdmConnect;
  *
  * a virAdmServer is a private structure and client-side representation of
  * a remote server object
+ *
+ * Since: v2.0.0
  */
 typedef struct _virAdmServer virAdmServer;
 
@@ -53,6 +57,8 @@ typedef struct _virAdmServer virAdmServer;
  *
  * a virAdmClient is a private structure and client-side representation of
  * a remote server's client object (as server sees clients connected to it)
+ *
+ * Since: v2.0.0
  */
 typedef struct _virAdmClient virAdmClient;
 
@@ -62,6 +68,8 @@ typedef struct _virAdmClient virAdmClient;
  * a virAdmConnectPtr is pointer to a virAdmConnect private structure,
  * this is the type used to reference a connection to the daemon
  * in the API.
+ *
+ * Since: v2.0.0
  */
 typedef virAdmConnect *virAdmConnectPtr;
 
@@ -71,6 +79,8 @@ typedef virAdmConnect *virAdmConnectPtr;
  * a virAdmServerPtr is a pointer to a virAdmServer structure,
  * this is the type used to reference client-side representation of a
  * remote server object throughout all the APIs.
+ *
+ * Since: v2.0.0
  */
 typedef virAdmServer *virAdmServerPtr;
 
@@ -80,6 +90,8 @@ typedef virAdmServer *virAdmServerPtr;
  * a virAdmClientPtr is a pointer to a virAdmClient structure,
  * this is the type used to reference client-side representation of a
  * client object throughout all the APIs.
+ *
+ * Since: v2.0.0
  */
 typedef virAdmClient *virAdmClientPtr;
 
@@ -216,6 +228,11 @@ long long virAdmClientGetTimestamp(virAdmClientPtr client);
 int virAdmClientGetTransport(virAdmClientPtr client);
 int virAdmClientFree(virAdmClientPtr client);
 
+/**
+ * virClientTransport:
+ *
+ * Since: v2.0.0
+ */
 typedef enum {
     VIR_CLIENT_TRANS_UNIX = 0, /* connection via UNIX socket (Since: v2.0.0) */
     VIR_CLIENT_TRANS_TCP,      /* connection via unencrypted TCP socket (Since: v2.0.0) */
-- 
2.35.1




[Index of Archives]     [Virt Tools]     [Libvirt Users]     [Lib OS Info]     [Fedora Users]     [Fedora Desktop]     [Fedora SELinux]     [Big List of Linux Books]     [Yosemite News]     [KDE Users]     [Fedora Tools]

  Powered by Linux