[PATCH v3 21/30] docstring: Fix and append Since to virDomainMemoryModFlags

[Peter Krempa]

On Wed, Apr 20, 2022 at 21:08:10 +0200, Victor Toso wrote:
> This commit is similar to "docs: Fix generated documentation of
> virConnectListAllNodeDeviceFlags", check it out for more info.
> 
> Signed-off-by: Victor Toso <victortoso at redhat.com>
> ---
>  include/libvirt/libvirt-domain.h | 13 ++++++-------
>  1 file changed, 6 insertions(+), 7 deletions(-)
> 
> diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-domain.h
> index 27a680a907..67cbc0d08e 100644
> --- a/include/libvirt/libvirt-domain.h
> +++ b/include/libvirt/libvirt-domain.h
> @@ -1958,18 +1958,17 @@ int     virDomainGetMemoryParameters(virDomainPtr domain,
>   * virDomainMemoryModFlags:
>   *
>   * Memory size modification flags.
> + * These flags may be bitwise-OR'd in.

Adding this makes no sense IMO.

>   *
> - * Since: v1.0.0
> + * Since: v0.9.0

Some previously-broken leftovers.

>   *
>   */
>  typedef enum {
> -    /* See virDomainModificationImpact for these flags. (Since: v1.0.0)  */
> -    VIR_DOMAIN_MEM_CURRENT = VIR_DOMAIN_AFFECT_CURRENT,
> -    VIR_DOMAIN_MEM_LIVE    = VIR_DOMAIN_AFFECT_LIVE,
> -    VIR_DOMAIN_MEM_CONFIG  = VIR_DOMAIN_AFFECT_CONFIG,
> +    VIR_DOMAIN_MEM_CURRENT = VIR_DOMAIN_AFFECT_CURRENT, /* See virDomainModificationImpact (Since: v0.9.1) */
> +    VIR_DOMAIN_MEM_LIVE    = VIR_DOMAIN_AFFECT_LIVE, /* See virDomainModificationImpact (Since: v0.9.0) */
> +    VIR_DOMAIN_MEM_CONFIG  = VIR_DOMAIN_AFFECT_CONFIG, /* See virDomainModificationImpact (Since: v0.9.0) */

I like this format.

>  
> -    /* Additionally, these flags may be bitwise-OR'd in. (Since: v1.0.0)  */

The since tag makes no sense here ;)

> -    VIR_DOMAIN_MEM_MAXIMUM = (1 << 2), /* affect Max rather than current */
> +    VIR_DOMAIN_MEM_MAXIMUM = (1 << 2), /* affect Max rather than current (Since: v0.9.1) */
>  } virDomainMemoryModFlags;
>  
>  
> -- 
> 2.35.1
>