| Message ID | 20201222161526.13841-1-laurent.pinchart@ideasonboard.com |
|---|---|
| State | Accepted |
| Delegated to: | Laurent Pinchart |
| Headers | show |
| Series |
|
| Related | show |
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@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@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 >
Hi Jacopo, On Wed, Dec 23, 2020 at 06:18:40PM +0100, Jacopo Mondi wrote: > 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@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 ? It's not the length that matters, but the fact there's another enum with the same enumerators (in the BayerFormat class). > The patch is however good! > > Tested-by: Jacopo Mondi <jacopo@jmondi.org> > > > 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}
Hi Laurent, Thanks for your work. On 2020-12-22 18:15:26 +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@ideasonboard.com> Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se> > --- > 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. > > 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 > > _______________________________________________ > libcamera-devel mailing list > libcamera-devel@lists.libcamera.org > https://lists.libcamera.org/listinfo/libcamera-devel
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}
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@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.