[PATCH v1 4/4] scripts: apibuild: add 'version' to variables

[Andrea Bolognani]

On Wed, Apr 06, 2022 at 10:49:47AM +0200, Victor Toso wrote:
> On Wed, Apr 06, 2022 at 01:10:40AM -0700, Andrea Bolognani wrote:
> > On Tue, Apr 05, 2022 at 08:31:40PM +0200, Victor Toso wrote:
> > > The documentation is not in the headers:
> > >
> > >     https://gitlab.com/libvirt/libvirt/-/blob/master/include/libvirt/libvirt-host.h#L565
> > >
> > > Only in the source:
> > >
> > >     https://gitlab.com/libvirt/libvirt/-/blob/master/src/libvirt.c#L200
> > >
> > > So, moving the documentation around could be an extra patch,
> > > indeed.
> >
> > A lot of documentation lives in the .c file, notably that for
> > functions. It's perfectly fine for it to be there and it doesn't need
> > to be moved.
>
> The suggestion of moving was to address what you pointed out
> previously, that users of libvirt can't figure out what that
> variable does without digging into the source code.

Once the docstring for the variable is parsed and it shows up in the
HTML documentation, it becomes just as discoverable as any of the
functions, which is perfectly fine :)

-- 
Andrea Bolognani / Red Hat / Virtualization