[libcamera-devel] [PATCH 03/31] libcamera: gen-controls: Fix documentation issue with <<

Laurent Pinchart laurent.pinchart at ideasonboard.com
Sat Feb 29 17:42:26 CET 2020


From: Jacopo Mondi <jacopo at jmondi.org>

Doxygen fails to parse entries with multiple << signs as, in example,
\var extern const Control<Span<int32_t>>

Remove the type from the control documentation as unique control and
properties name should not need any additional information specified for
Doxygen to correctly identify them.

Not sure this patch is the right way to fix this, but it's mostly here
to highlight an issue.

Signed-off-by: Jacopo Mondi <jacopo at jmondi.org>
---
 src/libcamera/gen-controls.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/libcamera/gen-controls.py b/src/libcamera/gen-controls.py
index 773e9b5d170c..6f020a327827 100755
--- a/src/libcamera/gen-controls.py
+++ b/src/libcamera/gen-controls.py
@@ -29,7 +29,7 @@ def generate_cpp(controls):
     enum_doc_value_template = string.Template(''' * \\var ${name}Values::${value}
 ${description}''')
     doc_template = string.Template('''/**
- * \\var extern const Control<${type}> ${name}
+ * \\var ${name}
 ${description}
  */''')
     def_template = string.Template('extern const Control<${type}> ${name}(${id_name}, "${name}");')
-- 
Regards,

Laurent Pinchart



More information about the libcamera-devel mailing list