Mirror/libcamera
1
0
Fork 0
mirror of https://git.libcamera.org/libcamera/libcamera.git synced 2025-07-24 00:55:07 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

libcamera: control_ids: Fix documentation for controls namespace

Browse source 
The controls namespace isn't documenting, making it impossible to
reference the variables it contains. Furthermore, within the
documentation page for the control_ids.h file, links from overview to
detailed variable documentation are broken for the same reason. Both
issues can be fixed by documenting the controls namespace.

Unfortunately doxygen then fails to parse the initialisers for the
controls global variables correctly and considers them as functions. To
work around this, modify the control_ids.cpp generation script to hide
the variables from doxygen, but still expose their documentation.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Jacopo Mondi <jacopo@jmondi.org>
Tested-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>
Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>
This commit is contained in:
Laurent Pinchart 2019-10-12 01:23:14 +03:00
parent 4ebc7297e1
commit 5af6a1a012
2 changed files with 24 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

13
src/libcamera/control_ids.cpp.in
View file

@ -16,9 +16,20 @@
namespace libcamera {
/**
* \brief Namespace for libcamera controls
*/
namespace controls {
${controls}
${controls_doc}
#ifndef __DOXYGEN__
/*
* Keep the controls definitions hidden from doxygen as it incorrectly parses
* them as functions.
*/
${controls_def}
#endif
} /* namespace controls */

18
src/libcamera/gen-controls.py
View file

@ -17,12 +17,14 @@ def snake_case(s):
def generate_cpp(controls):
template = string.Template('''/**
doc_template = string.Template('''/**
* \\var extern const Control<${type}> ${name}
${description}
*/
extern const Control<${type}> ${name}(${id_name}, "${name}");''')
*/''')
def_template = string.Template('extern const Control<${type}> ${name}(${id_name}, "${name}");')
ctrls = []
ctrls_doc = []
ctrls_def = []
for ctrl in controls:
name, ctrl = ctrl.popitem()
@ -39,9 +41,13 @@ extern const Control<${type}> ${name}(${id_name}, "${name}");''')
'id_name': id_name,
}
ctrls.append(template.substitute(info))
ctrls_doc.append(doc_template.substitute(info))
ctrls_def.append(def_template.substitute(info))
return {'controls': '\n\n'.join(ctrls)}
return {
'controls_doc': '\n\n'.join(ctrls_doc),
'controls_def': '\n'.join(ctrls_def),
}
def generate_h(controls):