[PATCH v3 18/30] docstring: Fix generated documentation of virStorageVolInfoFlags

[Peter Krempa]

On Thu, Apr 21, 2022 at 15:43:55 +0200, Peter Krempa wrote:
> On Wed, Apr 20, 2022 at 21:08:07 +0200, Victor Toso wrote:
> > This commit is similar to "docs: Fix generated documentation of
> > virConnectListAllNodeDeviceFlags", check it out for more info.

Actually, this paragraph is inaccurate since the commits were renamed.

I'd prefer a standalone description of what's going on so since this
patch is okay itself I'll probably go with:

The API xml description file generator doesn't properly handle cases
when there's either a single comment or mixed use of pre- and post-
comments explaining the values.

Modify the comments to avoid the problem and also append version
information for the exposed values.

> > 
> > Using git diff --word-diff to show the fixed output xml (redacted).
> > 
> >   <enum name='VIR_STORAGE_VOL_GET_PHYSICAL' ...
> >     [-type='virStorageVolInfoFlags'/>-]
> >     {+type='virStorageVolInfoFlags' version='3.0.0' info='Return the physical size in allocation'/>+}
> >   ...
> >   <enum name='VIR_STORAGE_VOL_USE_ALLOCATION' ... type='virStorageVolInfoFlags'
> >     [-info='Return the physical size in allocation'/>-]
> >     {+version='3.0.0'/>+}

This is also inaccurate as version info isn't added to the XML yet.

I'll probably just drop this part.


> > 
> > Signed-off-by: Victor Toso <victortoso at redhat.com>
> > ---
> >  include/libvirt/libvirt-storage.h | 7 ++-----
> >  1 file changed, 2 insertions(+), 5 deletions(-)
> 
> Reviewed-by: Peter Krempa <pkrempa at redhat.com>
>