[PATCH v3 12/30] docstring: typedef: admin:: Add 'Since version' metadata
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(a)redhat.com>
---
include/libvirt/libvirt-admin.h | 24 ++++++++++++++++++++++++
1 file changed, 24 insertions(+)
diff --git a/include/libvirt/libvirt-admin.h b/include/libvirt/libvirt-admin.h
index defca505f8..c73cf6e7da 100644
--- a/include/libvirt/libvirt-admin.h
+++ b/include/libvirt/libvirt-admin.h
@@ -37,6 +37,9 @@ extern "C" {
*
* a virAdmConnect is a private structure representing a connection to
* libvirt daemon.
+ *
+ * Since: v1.2.17
+ *
*/
typedef struct _virAdmConnect virAdmConnect;
@@ -45,6 +48,9 @@ typedef struct _virAdmConnect virAdmConnect;
*
* a virAdmServer is a private structure and client-side representation of
* a remote server object
+ *
+ * Since: v1.3.2
+ *
*/
typedef struct _virAdmServer virAdmServer;
@@ -53,6 +59,9 @@ 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: v1.3.5
+ *
*/
typedef struct _virAdmClient virAdmClient;
@@ -62,6 +71,9 @@ 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: v1.2.17
+ *
*/
typedef virAdmConnect *virAdmConnectPtr;
@@ -71,6 +83,9 @@ 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: v1.3.2
+ *
*/
typedef virAdmServer *virAdmServerPtr;
@@ -80,6 +95,9 @@ 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: v1.3.5
+ *
*/
typedef virAdmClient *virAdmClientPtr;
@@ -222,6 +240,12 @@ long long virAdmClientGetTimestamp(virAdmClientPtr client);
int virAdmClientGetTransport(virAdmClientPtr client);
int virAdmClientFree(virAdmClientPtr client);
+/**
+ * virClientTransport:
+ *
+ * Since: v1.3.5
+ *
+ */
typedef enum {
VIR_CLIENT_TRANS_UNIX = 0, /* connection via UNIX socket (Since: v1.3.5) */
VIR_CLIENT_TRANS_TCP, /* connection via unencrypted TCP socket (Since: v1.3.5)
*/
--
2.35.1