From nobody Tue Feb 10 12:39:56 2026 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) client-ip=170.10.133.124; envelope-from=libvir-list-bounces@redhat.com; helo=us-smtp-delivery-124.mimecast.com; Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1649969396; cv=none; d=zohomail.com; s=zohoarc; b=l4FALxZdAYaGw0ZIxXjdL/F6AsGOcG5elw1Io1BS0maj4Oe0YfDqq9uwHPKZXUWkxqk0IpLNMXFwzGDtUaayK7OhuHyn9S/epevWZgGicX3omJ6vv1DdXJAY2CxRv3bTljvxKNJz7S7Umm43f59+lpwLRHBy5RsbWFZMG6NgASc= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1649969396; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=1+X5Qoqdad8XCWA65OhmakoL2ImQHbeck1tp0aBtmys=; b=aYFk+yC2AvW927UU80wd9XI2VC7IN2WqyGmA3RJ539KUEh3Dhmbskd3/KxosogRFsaysJ2QtfqpDRHUgDA2vCoodxrw65nipgw2gtcrJalwcIWfJ2eDIxz1cEttJXqSiwvBqnFPoom0CdJ/GCuDBfHdd8NgZfiB/5jsJKEPkFe4= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of redhat.com designates 170.10.133.124 as permitted sender) smtp.mailfrom=libvir-list-bounces@redhat.com; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by mx.zohomail.com with SMTPS id 1649969396354545.4961738023817; Thu, 14 Apr 2022 13:49:56 -0700 (PDT) Received: from mimecast-mx02.redhat.com (mx3-rdu2.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-82-xRh9G8d4Mbux-N0YwjXUqQ-1; Thu, 14 Apr 2022 16:49:49 -0400 Received: from smtp.corp.redhat.com (int-mx01.intmail.prod.int.rdu2.redhat.com [10.11.54.1]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id C3AA9296A621; Thu, 14 Apr 2022 20:49:46 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com [10.30.29.100]) by smtp.corp.redhat.com (Postfix) with ESMTP id AF15B41136E0; Thu, 14 Apr 2022 20:49:46 +0000 (UTC) Received: from mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (localhost [IPv6:::1]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id 86268194034D; Thu, 14 Apr 2022 20:49:46 +0000 (UTC) Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.rdu2.redhat.com [10.11.54.6]) by mm-prod-listman-01.mail-001.prod.us-east-1.aws.redhat.com (Postfix) with ESMTP id B1A65194034D for ; Thu, 14 Apr 2022 20:49:44 +0000 (UTC) Received: by smtp.corp.redhat.com (Postfix) id 8A8FE2167D69; Thu, 14 Apr 2022 20:49:44 +0000 (UTC) Received: from tapioca.home (unknown [10.40.193.2]) by smtp.corp.redhat.com (Postfix) with ESMTP id E66432167D64 for ; Thu, 14 Apr 2022 20:49:43 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1649969395; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post; bh=1+X5Qoqdad8XCWA65OhmakoL2ImQHbeck1tp0aBtmys=; b=GdN0TBqC0H5A6NFpiN7Gg4uhRFfKMSRpdjb3jLhs21Z6lqidRNUnxCkoZgKg6lOCeK/1Xx SO64b3m5FtVRp1NCT4U1ipsBl9TaYq+PZPQTRS6uK1PdEXO1VOt0mU/BAZz2Sw5ojDdm/U CTxWol/n1osY1HBuG1A/FmA4gOAZm0k= X-MC-Unique: xRh9G8d4Mbux-N0YwjXUqQ-1 X-Original-To: libvir-list@listman.corp.redhat.com From: Victor Toso To: libvir-list@redhat.com Subject: [PATCH v2 15/34] docs: manual: typedef: add docstring and Since metadata Date: Thu, 14 Apr 2022 22:47:26 +0200 Message-Id: <20220414204745.108966-16-victortoso@redhat.com> In-Reply-To: <20220414204745.108966-1-victortoso@redhat.com> References: <20220414204745.108966-1-victortoso@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.78 on 10.11.54.6 X-BeenThere: libvir-list@redhat.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Development discussions about the libvirt library & tools List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: libvir-list-bounces@redhat.com Sender: "libvir-list" X-Scanned-By: MIMEDefang 2.84 on 10.11.54.1 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=libvir-list-bounces@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1649969396826100002 Content-Type: text/plain; charset="utf-8"; x-default="true" This commit finishes the script work and adds docstring to types that are not documented. From this commit onwards, all exported typedefs are versioned. Further commits will enforce that it stays like that with new additions. Signed-off-by: Victor Toso --- include/libvirt/libvirt-domain-checkpoint.h | 16 ++- include/libvirt/libvirt-domain-snapshot.h | 16 ++- include/libvirt/libvirt-domain.h | 147 ++++++++++++++++++-- include/libvirt/libvirt-host.h | 20 ++- include/libvirt/libvirt-interface.h | 12 ++ include/libvirt/libvirt-network.h | 27 +++- include/libvirt/libvirt-nwfilter.h | 13 +- include/libvirt/libvirt-qemu.h | 6 + include/libvirt/libvirt-secret.h | 14 +- include/libvirt/libvirt-storage.h | 52 ++++++- include/libvirt/virterror.h | 7 + 11 files changed, 303 insertions(+), 27 deletions(-) diff --git a/include/libvirt/libvirt-domain-checkpoint.h b/include/libvirt/= libvirt-domain-checkpoint.h index 1a1631b9cf..5a53717175 100644 --- a/include/libvirt/libvirt-domain-checkpoint.h +++ b/include/libvirt/libvirt-domain-checkpoint.h @@ -77,7 +77,12 @@ typedef enum { virDomainCheckpointPtr virDomainCheckpointCreateXML(virDomainPtr domain, const char *xmlDesc, unsigned int flags); - +/** + * virDomainCheckpointXMLFlags: + * + * Since: v5.6.0 + * + */ typedef enum { VIR_DOMAIN_CHECKPOINT_XML_SECURE =3D (1 << 0), /* Include sensitive= data (Since: v5.6.0) */ VIR_DOMAIN_CHECKPOINT_XML_NO_DOMAIN =3D (1 << 1), /* Suppress @@ -139,7 +144,14 @@ virDomainCheckpointPtr virDomainCheckpointLookupByName= (virDomainPtr domain, virDomainCheckpointPtr virDomainCheckpointGetParent(virDomainCheckpointPtr= checkpoint, unsigned int flags); =20 -/* Delete a checkpoint */ +/** + * virDomainCheckpointDeleteFlags: + * + * Delete a checkpoint + * + * Since: v5.6.0 + * + */ typedef enum { VIR_DOMAIN_CHECKPOINT_DELETE_CHILDREN =3D (1 << 0), /* Also delet= e children (Since: v5.6.0) */ VIR_DOMAIN_CHECKPOINT_DELETE_METADATA_ONLY =3D (1 << 1), /* Delete jus= t metadata (Since: v5.6.0) */ diff --git a/include/libvirt/libvirt-domain-snapshot.h b/include/libvirt/li= bvirt-domain-snapshot.h index aa7bfa903a..9cbbcb5650 100644 --- a/include/libvirt/libvirt-domain-snapshot.h +++ b/include/libvirt/libvirt-domain-snapshot.h @@ -91,7 +91,12 @@ typedef enum { virDomainSnapshotPtr virDomainSnapshotCreateXML(virDomainPtr domain, const char *xmlDesc, unsigned int flags); - +/** + * virDomainSnapshotXMLFlags: + * + * Since: v5.1.0 + * + */ typedef enum { VIR_DOMAIN_SNAPSHOT_XML_SECURE =3D VIR_DOMAIN_XML_SECURE, /* d= ump security sensitive information too (Since: v5.1.0) */ } virDomainSnapshotXMLFlags; @@ -230,7 +235,14 @@ typedef enum { int virDomainRevertToSnapshot(virDomainSnapshotPtr snapshot, unsigned int flags); =20 -/* Delete a snapshot */ +/** + * virDomainSnapshotDeleteFlags: + * + * Delete a snapshot + * + * Since: v1.0.0 + * + */ typedef enum { VIR_DOMAIN_SNAPSHOT_DELETE_CHILDREN =3D (1 << 0), /* Also delete = children (Since: v1.0.0) */ VIR_DOMAIN_SNAPSHOT_DELETE_METADATA_ONLY =3D (1 << 1), /* Delete just = metadata (Since: v1.0.0) */ diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-dom= ain.h index 8d04a0b989..77c6e6f3a7 100644 --- a/include/libvirt/libvirt-domain.h +++ b/include/libvirt/libvirt-domain.h @@ -885,7 +885,7 @@ struct _virDomainMemoryStat { }; =20 /** - * *virDomainMemoryStatPtr: + * virDomainMemoryStatPtr: * * Since: v1.0.0 * @@ -893,7 +893,14 @@ struct _virDomainMemoryStat { typedef virDomainMemoryStatStruct *virDomainMemoryStatPtr; =20 =20 -/* Domain core dump flags. */ +/** + * virDomainCoreDumpFlags: + * + * Domain core dump flags. + * + * Since: v1.0.0 + * + */ typedef enum { VIR_DUMP_CRASH =3D (1 << 0), /* crash after dump (Since: v1.0.0= ) */ VIR_DUMP_LIVE =3D (1 << 1), /* live dump (Since: v1.0.0) */ @@ -2032,7 +2039,12 @@ int virDomainSetMemoryStatsPerio= d (virDomainPtr domain, int virDomainGetMaxVcpus (virDomainPtr domain); int virDomainGetSecurityLabel (virDomainPtr domain, virSecurityLabelPtr sec= label); - +/** + * virDomainGetHostnameFlags: + * + * Since: v6.1.0 + * + */ typedef enum { VIR_DOMAIN_GET_HOSTNAME_LEASE =3D (1 << 0), /* Parse DHCP lease file (= Since: v6.1.0) */ VIR_DOMAIN_GET_HOSTNAME_AGENT =3D (1 << 1), /* Query qemu guest agent = (Since: v6.1.0) */ @@ -2297,8 +2309,14 @@ int virDomainMemoryStats (virDom= ainPtr dom, unsigned int nr_stats, unsigned int flags); =20 -/* Memory peeking flags. */ - +/** + * virDomainMemoryFlags: + * + * Memory peeking flags. + * + * Since: v1.0.0 + * + */ typedef enum { VIR_MEMORY_VIRTUAL =3D 1 << 0, /* addresses are virtual add= resses (Since: v1.0.0) */ VIR_MEMORY_PHYSICAL =3D 1 << 1, /* addresses are physical ad= dresses (Since: v1.0.0) */ @@ -2310,6 +2328,12 @@ int virDomainMemoryPeek (virDoma= inPtr dom, void *buffer, unsigned int flags); =20 +/** + * virDomainDefineFlags: + * + * Since: v1.2.12 + * + */ typedef enum { VIR_DOMAIN_DEFINE_VALIDATE =3D (1 << 0), /* Validate the XML document = against schema (Since: v1.2.12) */ } virDomainDefineFlags; @@ -2423,6 +2447,12 @@ typedef enum { # endif } virVcpuState; =20 +/** + * virVcpuHostCpuState: + * + * Since: v6.10.0 + * + */ typedef enum { VIR_VCPU_INFO_CPU_OFFLINE =3D -1, /* the vCPU is offline (Since: v= 6.10.0) */ VIR_VCPU_INFO_CPU_UNAVAILABLE =3D -2, /* the hypervisor does not expos= e real CPU information (Since: v6.10.0) */ @@ -2443,7 +2473,7 @@ struct _virVcpuInfo { }; =20 /** - * *virVcpuInfoPtr: + * virVcpuInfoPtr: * * Since: v1.0.0 * @@ -2513,6 +2543,14 @@ int virDomainGetEmulatorPinInfo = (virDomainPtr domain, * */ typedef struct _virDomainIOThreadInfo virDomainIOThreadInfo; + + +/** + * virDomainIOThreadInfoPtr: + * + * Since: v1.2.14 + * + */ typedef virDomainIOThreadInfo *virDomainIOThreadInfoPtr; struct _virDomainIOThreadInfo { unsigned int iothread_id; /* IOThread ID */ @@ -2746,6 +2784,13 @@ int virDomainDetachDeviceAlias(virDomainPtr domain, * */ typedef struct _virDomainStatsRecord virDomainStatsRecord; + +/** + * virDomainStatsRecordPtr: + * + * Since: v1.2.8 + * + */ typedef virDomainStatsRecord *virDomainStatsRecordPtr; struct _virDomainStatsRecord { virDomainPtr dom; @@ -2772,6 +2817,12 @@ typedef enum { VIR_DOMAIN_STATS_DIRTYRATE =3D (1 << 9), /* return domain dirty rate i= nfo (Since: v7.2.0) */ } virDomainStatsTypes; =20 +/** + * virConnectGetAllDomainStatsFlags: + * + * Since: v1.2.8 + * + */ typedef enum { VIR_CONNECT_GET_ALL_DOMAINS_STATS_ACTIVE =3D VIR_CONNECT_LIST_DOMAINS_= ACTIVE, VIR_CONNECT_GET_ALL_DOMAINS_STATS_INACTIVE =3D VIR_CONNECT_LIST_DOMAIN= S_INACTIVE, @@ -3180,13 +3231,27 @@ typedef enum { int virDomainBlockJobAbort(virDomainPtr dom, const char *disk, unsigned int flags); =20 -/* Flags for use with virDomainGetBlockJobInfo */ +/** + * virDomainBlockJobInfoFlags: + * + * Flags for use with virDomainGetBlockJobInfo + * + * Since: v1.2.9 + * + */ typedef enum { VIR_DOMAIN_BLOCK_JOB_INFO_BANDWIDTH_BYTES =3D 1 << 0, /* bandwidth in = bytes/s instead of MiB/= s (Since: v1.2.9) */ } virDomainBlockJobInfoFlags; =20 -/* An iterator for monitoring block job operations */ +/** + * virDomainBlockJobCursor: + * + * An iterator for monitoring block job operations + * + * Since: v1.0.0 + * + */ typedef unsigned long long virDomainBlockJobCursor; =20 /** @@ -3211,7 +3276,7 @@ struct _virDomainBlockJobInfo { }; =20 /** - * *virDomainBlockJobInfoPtr: + * virDomainBlockJobInfoPtr: * * Since: v1.0.0 * @@ -3222,7 +3287,14 @@ int virDomainGetBlockJobInfo(virDomainPtr dom, const= char *disk, virDomainBlockJobInfoPtr info, unsigned int flags); =20 -/* Flags for use with virDomainBlockJobSetSpeed */ +/** + * virDomainBlockJobSetSpeedFlags: + * + * Flags for use with virDomainBlockJobSetSpeed + * + * Since: v1.2.9 + * + */ typedef enum { VIR_DOMAIN_BLOCK_JOB_SPEED_BANDWIDTH_BYTES =3D 1 << 0, /* bandwidth in= bytes/s instead of MiB= /s (Since: v1.2.9) */ @@ -3231,8 +3303,15 @@ typedef enum { int virDomainBlockJobSetSpeed(virDomainPtr dom, const char *disk, unsigned long bandwidth, unsigned int flags); =20 -/* Flags for use with virDomainBlockPull (values chosen to be a subset - * of the flags for virDomainBlockRebase) */ +/** + * virDomainBlockPullFlags: + * + * Flags for use with virDomainBlockPull (values chosen to be a subset of = the + * flags for virDomainBlockRebase) + * + * Since: v1.2.9 + * + */ typedef enum { VIR_DOMAIN_BLOCK_PULL_BANDWIDTH_BYTES =3D 1 << 6, /* bandwidth in byte= s/s instead of MiB/s (S= ince: v1.2.9) */ @@ -3635,7 +3714,7 @@ typedef enum { typedef struct _virDomainDiskError virDomainDiskError; =20 /** - * *virDomainDiskErrorPtr: + * virDomainDiskErrorPtr: * * Since: v1.0.0 * @@ -4177,7 +4256,7 @@ typedef enum { typedef struct _virDomainJobInfo virDomainJobInfo; =20 /** - * *virDomainJobInfoPtr: + * virDomainJobInfoPtr: * * Since: v1.0.0 * @@ -6081,7 +6160,15 @@ int virDomainFSThaw(virDomainPtr dom, * */ typedef struct _virDomainFSInfo virDomainFSInfo; + +/** + * virDomainFSInfoPtr: + * + * Since: v1.2.11 + * + */ typedef virDomainFSInfo *virDomainFSInfoPtr; + struct _virDomainFSInfo { char *mountpoint; /* path to mount point */ char *name; /* device name in the guest (e.g. "sda1") */ @@ -6100,7 +6187,12 @@ int virDomainGetTime(virDomainPtr dom, long long *seconds, unsigned int *nseconds, unsigned int flags); - +/** + * virDomainSetTimeFlags: + * + * Since: v1.2.5 + * + */ typedef enum { VIR_DOMAIN_TIME_SYNC =3D (1 << 0), /* Re-sync domain time from domain'= s RTC (Since: v1.2.5) */ } virDomainSetTimeFlags; @@ -6319,6 +6411,13 @@ struct _virDomainInterfaceIPAddress { * */ typedef struct _virDomainInterface virDomainInterface; + +/** + * virDomainInterfacePtr: + * + * Since: v1.2.14 + * + */ typedef virDomainInterface *virDomainInterfacePtr; struct _virDomainInterface { char *name; /* interface name */ @@ -6334,6 +6433,12 @@ int virDomainInterfaceAddresses(virDomainPtr dom, =20 void virDomainInterfaceFree(virDomainInterfacePtr iface); =20 +/** + * virDomainSetUserPasswordFlags: + * + * Since: v1.2.16 + * + */ typedef enum { VIR_DOMAIN_PASSWORD_ENCRYPTED =3D 1 << 0, /* the password is already e= ncrypted (Since: v1.2.16) */ } virDomainSetUserPasswordFlags; @@ -6554,6 +6659,12 @@ int virDomainAgentSetResponseTimeout(virDomainPtr do= main, int timeout, unsigned int flags); =20 +/** + * virDomainBackupBeginFlags: + * + * Since: v6.0.0 + * + */ typedef enum { VIR_DOMAIN_BACKUP_BEGIN_REUSE_EXTERNAL =3D (1 << 0), /* reuse separate= ly provided images = (Since: v6.0.0) */ @@ -6572,6 +6683,12 @@ int virDomainAuthorizedSSHKeysGet(virDomainPtr domai= n, char ***keys, unsigned int flags); =20 +/** + * virDomainAuthorizedSSHKeysSetFlags: + * + * Since: v6.10.0 + * + */ typedef enum { VIR_DOMAIN_AUTHORIZED_SSH_KEYS_SET_APPEND =3D (1 << 0), /* don't trunc= ate file, just append (Since: v6.10.0) */ VIR_DOMAIN_AUTHORIZED_SSH_KEYS_SET_REMOVE =3D (1 << 1), /* remove keys= , instead of adding them (Since: v6.10.0) */ diff --git a/include/libvirt/libvirt-host.h b/include/libvirt/libvirt-host.h index d366cc903e..74d3583bd7 100644 --- a/include/libvirt/libvirt-host.h +++ b/include/libvirt/libvirt-host.h @@ -645,7 +645,12 @@ typedef enum { VIR_CONNECT_NO_ALIASES =3D (1 << 1), /* Don't try to resolve URI alia= ses (Since: v1.0.0) */ } virConnectFlags; =20 - +/** + * virConnectCredentialType: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_CRED_USERNAME =3D 1, /* Identity to act as (Since: v1.0.0) */ VIR_CRED_AUTHNAME =3D 2, /* Identify to authorize as (Since: v1.0.= 0) */ @@ -724,6 +729,12 @@ struct _virConnectAuth { */ typedef struct _virConnectAuth virConnectAuth; =20 +/** + * virConnectAuthPtr: + * + * Since: v1.0.0 + * + */ typedef virConnectAuth *virConnectAuthPtr; =20 /* @@ -1049,7 +1060,12 @@ int virNodeGetFreePages(virConnectPtr conn, unsigned int cellcount, unsigned long long *counts, unsigned int flags); - +/** + * virNodeAllocPagesFlags: + * + * Since: v1.2.9 + * + */ typedef enum { VIR_NODE_ALLOC_PAGES_ADD =3D 0, /* Add @pageCounts to the pages pool. = This can be used only to size up the pool.= (Since: v1.2.9) */ diff --git a/include/libvirt/libvirt-interface.h b/include/libvirt/libvirt-= interface.h index 22a90a6452..bf7e915432 100644 --- a/include/libvirt/libvirt-interface.h +++ b/include/libvirt/libvirt-interface.h @@ -84,10 +84,22 @@ virInterfacePtr virInterfaceLookupByMACString (= virConnectPtr conn, const char* virInterfaceGetName (virInterfacePtr iface); const char* virInterfaceGetMACString (virInterfacePtr iface); =20 +/** + * virInterfaceXMLFlags: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_INTERFACE_XML_INACTIVE =3D 1 << 0 /* dump inactive interface infor= mation (Since: v1.0.0) */ } virInterfaceXMLFlags; =20 +/** + * virInterfaceDefineFlags: + * + * Since: v7.7.0 + * + */ typedef enum { VIR_INTERFACE_DEFINE_VALIDATE =3D 1 << 0, /* Validate the XML document= against schema (Since: v7.7.0) */ } virInterfaceDefineFlags; diff --git a/include/libvirt/libvirt-network.h b/include/libvirt/libvirt-ne= twork.h index 0457771fb7..953a11e8f3 100644 --- a/include/libvirt/libvirt-network.h +++ b/include/libvirt/libvirt-network.h @@ -27,6 +27,12 @@ # error "Don't include this file directly, only use libvirt/libvirt.h" # endif =20 +/** + * virNetworkXMLFlags: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_NETWORK_XML_INACTIVE =3D (1 << 0), /* dump inactive network inform= ation (Since: v1.0.0) */ } virNetworkXMLFlags; @@ -127,7 +133,12 @@ virNetworkPtr virNetworkLookupByUUID = (virConnectPtr conn, const unsigned ch= ar *uuid); virNetworkPtr virNetworkLookupByUUIDString (virConnectPtr con= n, const char *uuid); - +/** + * virNetworkCreateFlags: + * + * Since: v7.8.0 + * + */ typedef enum { VIR_NETWORK_CREATE_VALIDATE =3D 1 << 0, /* Validate the XML document a= gainst schema (Since: v7.8.0) */ } virNetworkCreateFlags; @@ -140,7 +151,12 @@ virNetworkPtr virNetworkCreateXML (virCo= nnectPtr conn, virNetworkPtr virNetworkCreateXMLFlags(virConnectPtr conn, const char *xmlDesc, unsigned int flags); - +/** + * virNetworkDefineFlags: + * + * Since: v7.7.0 + * + */ typedef enum { VIR_NETWORK_DEFINE_VALIDATE =3D 1 << 0, /* Validate the XML document a= gainst schema (Since: v7.7.0) */ } virNetworkDefineFlags; @@ -362,6 +378,13 @@ typedef enum { * */ typedef struct _virNetworkDHCPLease virNetworkDHCPLease; + +/** + * virNetworkDHCPLeasePtr: + * + * Since: v1.2.6 + * + */ typedef virNetworkDHCPLease *virNetworkDHCPLeasePtr; struct _virNetworkDHCPLease { char *iface; /* Network interface name */ diff --git a/include/libvirt/libvirt-nwfilter.h b/include/libvirt/libvirt-n= wfilter.h index 5c78ea9d8b..8497d85f48 100644 --- a/include/libvirt/libvirt-nwfilter.h +++ b/include/libvirt/libvirt-nwfilter.h @@ -91,7 +91,12 @@ virNWFilterPtr virNWFilterLookupByUUID (v= irConnectPtr conn, const unsigned char= *uuid); virNWFilterPtr virNWFilterLookupByUUIDString (virConnectPtr conn, const char *uuid); - +/** + * virNWFilterDefineFlags: + * + * Since: v7.7.0 + * + */ typedef enum { VIR_NWFILTER_DEFINE_VALIDATE =3D 1 << 0, /* Validate the XML document = against schema (Since: v7.7.0) */ } virNWFilterDefineFlags; @@ -120,6 +125,12 @@ int virNWFilterFree (virNW= FilterPtr nwfilter); * NWFilter information */ =20 +/** + * virNWFilterBindingCreateFlags: + * + * Since: v7.8.0 + * + */ typedef enum { VIR_NWFILTER_BINDING_CREATE_VALIDATE =3D 1 << 0, /* Validate the XML d= ocument against schema (Since: v7.8.0) */ } virNWFilterBindingCreateFlags; diff --git a/include/libvirt/libvirt-qemu.h b/include/libvirt/libvirt-qemu.h index b85e77f5b1..e4c74d72c6 100644 --- a/include/libvirt/libvirt-qemu.h +++ b/include/libvirt/libvirt-qemu.h @@ -30,6 +30,12 @@ extern "C" { # endif =20 +/** + * virDomainQemuMonitorCommandFlags: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_DOMAIN_QEMU_MONITOR_COMMAND_DEFAULT =3D 0, VIR_DOMAIN_QEMU_MONITOR_COMMAND_HMP =3D (1 << 0), /* cmd is in HMP= (Since: v1.0.0) */ diff --git a/include/libvirt/libvirt-secret.h b/include/libvirt/libvirt-sec= ret.h index 1f0fc41c0c..a33cbc8779 100644 --- a/include/libvirt/libvirt-secret.h +++ b/include/libvirt/libvirt-secret.h @@ -38,6 +38,13 @@ * */ typedef struct _virSecret virSecret; + +/** + * virSecretPtr: + * + * Since: v1.0.0 + * + */ typedef virSecret *virSecretPtr; =20 /** @@ -100,7 +107,12 @@ virSecretPtr virSecretLookupByUUIDString(vi= rConnectPtr conn, virSecretPtr virSecretLookupByUsage(virConnectPtr conn, int usageType, const char *usageID); - +/** + * virSecretDefineFlags: + * + * Since: v7.7.0 + * + */ typedef enum { VIR_SECRET_DEFINE_VALIDATE =3D 1 << 0, /* Validate the XML document ag= ainst schema (Since: v7.7.0) */ } virSecretDefineFlags; diff --git a/include/libvirt/libvirt-storage.h b/include/libvirt/libvirt-st= orage.h index 8f0352237c..3ce8ca92d6 100644 --- a/include/libvirt/libvirt-storage.h +++ b/include/libvirt/libvirt-storage.h @@ -68,6 +68,12 @@ typedef enum { # endif } virStoragePoolState; =20 +/** + * virStoragePoolBuildFlags: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_STORAGE_POOL_BUILD_NEW =3D 0, /* Regular build from scratch (Si= nce: v1.0.0) */ VIR_STORAGE_POOL_BUILD_REPAIR =3D (1 << 0), /* Repair / reinitialize (= Since: v1.0.0) */ @@ -76,6 +82,12 @@ typedef enum { VIR_STORAGE_POOL_BUILD_OVERWRITE =3D (1 << 3), /* Overwrite data (Sin= ce: v1.0.0) */ } virStoragePoolBuildFlags; =20 +/** + * virStoragePoolDeleteFlags: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_STORAGE_POOL_DELETE_NORMAL =3D 0, /* Delete metadata only (fast= ) (Since: v1.0.0) */ VIR_STORAGE_POOL_DELETE_ZEROED =3D 1 << 0, /* Clear all data to zeros= (slow) (Since: v1.0.0) */ @@ -255,8 +267,21 @@ struct _virStorageVolInfo { unsigned long long allocation; /* Current allocation bytes */ }; =20 + +/** + * virStorageVolInfoPtr: + * + * Since: v1.0.0 + * + */ typedef virStorageVolInfo *virStorageVolInfoPtr; =20 +/** + * virStorageXMLFlags: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_STORAGE_XML_INACTIVE =3D (1 << 0), /* dump inactive pool/volume= information (Since: v1.0.0) */ } virStorageXMLFlags; @@ -346,7 +371,12 @@ virStoragePoolPtr virStoragePoolLookupByUUIDStri= ng(virConnectPtr conn, virStoragePoolPtr virStoragePoolLookupByVolume (virStorageVolPtr = vol); virStoragePoolPtr virStoragePoolLookupByTargetPath(virConnectPtr con= n, const char *path); - +/** + * virStoragePoolDefineFlags: + * + * Since: v7.7.0 + * + */ typedef enum { VIR_STORAGE_POOL_DEFINE_VALIDATE =3D 1 << 0, /* Validate the XML docum= ent against schema (Since: v7.7.0) */ } virStoragePoolDefineFlags; @@ -438,7 +468,12 @@ virStorageVolPtr virStorageVolCreateXMLFrom = (virStoragePoolPtr pool, const char *xmlde= sc, virStorageVolPtr = clonevol, unsigned int flag= s); - +/** + * virStorageVolDownloadFlags: + * + * Since: v3.4.0 + * + */ typedef enum { VIR_STORAGE_VOL_DOWNLOAD_SPARSE_STREAM =3D 1 << 0, /* Use sparse strea= m (Since: v3.4.0) */ } virStorageVolDownloadFlags; @@ -448,6 +483,13 @@ int virStorageVolDownload = (virStorageVolPtr vol, unsigned long lon= g offset, unsigned long lon= g length, unsigned int flag= s); + +/** + * virStorageVolUploadFlags: + * + * Since: v3.4.0 + * + */ typedef enum { VIR_STORAGE_VOL_UPLOAD_SPARSE_STREAM =3D 1 << 0, /* Use sparse stream= (Since: v3.4.0) */ } virStorageVolUploadFlags; @@ -477,6 +519,12 @@ char * virStorageVolGetXMLDesc = (virStorageVolPtr pool, =20 char * virStorageVolGetPath (virStorageVolPtr = vol); =20 +/** + * virStorageVolResizeFlags: + * + * Since: v1.0.0 + * + */ typedef enum { VIR_STORAGE_VOL_RESIZE_ALLOCATE =3D 1 << 0, /* force allocation of new= size (Since: v1.0.0) */ VIR_STORAGE_VOL_RESIZE_DELTA =3D 1 << 1, /* size is relative to cur= rent (Since: v1.0.0) */ diff --git a/include/libvirt/virterror.h b/include/libvirt/virterror.h index 76b20e410c..aa47d59ba1 100644 --- a/include/libvirt/virterror.h +++ b/include/libvirt/virterror.h @@ -164,6 +164,13 @@ typedef enum { */ =20 typedef struct _virError virError; + +/** + * virErrorPtr: + * + * Since: v1.0.0 + * + */ typedef virError *virErrorPtr; struct _virError { int code; /* The error code, a virErrorNumber */ --=20 2.35.1