[libcamera-devel,v2,03/32] libcamera: gen-controls: Fix documentation issue with <<
diff mbox series

Message ID 20200306160002.30549-4-laurent.pinchart@ideasonboard.com
State Accepted
Headers show
Series
  • libcamera: Add support for array controls
Related show

Commit Message

Laurent Pinchart March 6, 2020, 3:59 p.m. UTC 
From: Jacopo Mondi <jacopo@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
property names should not need any additional information specified for
Doxygen to correctly identify them.

Signed-off-by: Jacopo Mondi <jacopo@jmondi.org>
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
---
Changes since v1:

- Commit message updates
---
 src/libcamera/gen-controls.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Patch
diff mbox series 

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}");')