[libcamera-devel,1/6] utils: gen-controls: Fix enumerators documentation
diff mbox series

Message ID 20201223174709.45457-2-jacopo@jmondi.org
State Accepted
Delegated to: Jacopo Mondi
Headers show
Series
  • android: support ColorFilterArrangement property
Related show

Commit Message

Jacopo Mondi Dec. 23, 2020, 5:47 p.m. UTC 
From: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

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>
Tested-by: Jacopo Mondi <jacopo@jmondi.org>
---
 utils/gen-controls.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Patch
diff mbox 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}