[libcamera-devel] [PATCH] utils: gen-controls: Fix enumerators documentation

[Jacopo Mondi]

Hi Laurent,

On Tue, Dec 22, 2020 at 06:15:26PM +0200, Laurent Pinchart wrote:
> The Doxygen documentation for enumerators prefixes the enumerator name
> with the enumeration name. For unscoped enumerations, this is incorrect.
> Drop the scope. This fixes warnings produced by Doxygen when multiple
> enumerators with identical names are defined in different scopes.
>
> Signed-off-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>
> ---
>  utils/gen-controls.py | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> Jacopo, I believe this should fix the issue you've experienced in your
> camera sensor database series.
>

It does!
However, why the heck the issue presented itself only with 4 letters
identifiers ?

The patch is however good!

Tested-by: Jacopo Mondi <jacopo at jmondi.org>

Thanks
  j

> diff --git a/utils/gen-controls.py b/utils/gen-controls.py
> index 12a32eaaeee9..3f99b5e2ba7d 100755
> --- a/utils/gen-controls.py
> +++ b/utils/gen-controls.py
> @@ -26,7 +26,7 @@ def generate_cpp(controls):
>      enum_doc_start_template = string.Template('''/**
>   * \\enum ${name}Enum
>   * \\brief Supported ${name} values''')
> -    enum_doc_value_template = string.Template(''' * \\var ${name}Enum::${value}
> +    enum_doc_value_template = string.Template(''' * \\var ${value}
>  ${description}''')
>      doc_template = string.Template('''/**
>   * \\var ${name}
> --
> Regards,
>
> Laurent Pinchart
>