NuKVM/libvirt
3
0
Fork 0
mirror of https://github.com/libvirt/libvirt.git synced 2025-02-25 18:55:26 -06:00
Code Issues Packages Projects Releases Wiki Activity

virNetworkGetDHCPLeases: fix docstring format

Browse Source 
The docstring of virNetworkGetDHCPLeases is not correctly formatted and
as a result the example code snippet appears as normal text under the
"Returns:" section. This patch fixes the problem.

Signed-off-by: Ilias Stamatis <stamatis.iliass@gmail.com>
This commit is contained in:
Ilias Stamatis 2019-06-18 16:21:57 +02:00 committed by Michal Privoznik
parent 37cca33403
commit ba1948611e
1 changed files with 22 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/libvirt-network.c
View File

@ -1156,8 +1156,7 @@ virConnectNetworkEventDeregisterAny(virConnectPtr conn,
* lease info about a specific guest interface with @mac. There can be * lease info about a specific guest interface with @mac. There can be
* multiple leases for a single @mac because this API supports DHCPv6 too. * multiple leases for a single @mac because this API supports DHCPv6 too.
* *
* Returns the number of leases found or -1 and sets @leases to NULL in * On success, the array stored into @leases is guaranteed to
* case of error. On success, the array stored into @leases is guaranteed to
* have an extra allocated element set to NULL but not included in the return * 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 * count, to make iteration easier. The caller is responsible for calling
* virNetworkDHCPLeaseFree() on each array element, then calling free() on @leases. * virNetworkDHCPLeaseFree() on each array element, then calling free() on @leases.
@ -1192,6 +1191,9 @@ virConnectNetworkEventDeregisterAny(virConnectPtr conn,
* *
* free(leases); * free(leases);
* *
* Returns the number of leases found or -1 and sets @leases to NULL in
* case of error.
*
*/ */
int int
virNetworkGetDHCPLeases(virNetworkPtr network, virNetworkGetDHCPLeases(virNetworkPtr network,