]> xenbits.xensource.com Git - libvirt.git/commit
docstring: variable: Move docstring from source to header file
authorVictor Toso <victortoso@redhat.com>
Wed, 20 Apr 2022 19:07:53 +0000 (21:07 +0200)
committerPeter Krempa <pkrempa@redhat.com>
Fri, 22 Apr 2022 07:45:00 +0000 (09:45 +0200)
commit89f35b12149a1f969f1a4134bdb6a06b341e7719
tree3cdfce23938fdf89a4bbac157bd241791fc3a875
parentc08dad9ae24ec48ee564e3ce0ad1567d81ce8743
docstring: variable: Move docstring from source to header file

virConnectAuthPtrDefault is the only variable that we export and
with the documentation being at the C file, it makes harder to find
it.

With this patch, the documentation of this variable can be found by
those who look at the header file for guidance plus, it will also be
included in the XML API, as the followup patch will fix apibuild.py
to store what is documented in the header file for this variable.

Note that the apibuild, does not do the same with .c files. It'd
require adding it for (parsing) recursion, similar to what is done
for functions.  Considering the pros/cons, seems more reasonable to
move the docstring to the header file instead.

Signed-off-by: Victor Toso <victortoso@redhat.com>
Reviewed-by: Peter Krempa <pkrempa@redhat.com>
include/libvirt/libvirt-host.h
src/libvirt.c