External/libvirt
1
0
Fork 0
Code

docstring: typedef: admin: Add 'Since version' metadata

Browse Source 
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@redhat.com>
Reviewed-by: Andrea Bolognani <abologna@redhat.com>
This commit is contained in:
Victor Toso 2022-04-22 21:23:35 +02:00 committed by Andrea Bolognani
parent a1d3324f02
commit 032724b9c4
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
include/libvirt/libvirt-admin.h
View File

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