summaryrefslogtreecommitdiff
path: root/utils
diff options
context:
space:
mode:
authorUmang Jain <umang.jain@ideasonboard.com>2021-05-24 14:50:18 +0530
committerLaurent Pinchart <laurent.pinchart@ideasonboard.com>2021-05-24 14:13:01 +0300
commitff9276cc626dce468d0f2aa63a908a836a7a33d5 (patch)
tree5fe050d58dc93c5d200033210e0b98b4c160d9a0 /utils
parentb9d55fe69ebb6bf146cf8696771faf61fa366762 (diff)
ipa: Move core IPA interface documentation to a .cpp file
Moving the core.mojom documentation to its corresponding .cpp file (core_ipa_interface.cpp). This will allow Doxygen to generate the documentation for IPABuffer, IPASettings and IPAStream structures. Since the .mojom files are placed in include/ directory, the .cpp file will live in $sourcedir/src/libcamera/ipa/ - which can also contain documentation for other mojom generated IPA interfaces in subsequent commit. Also hide the constructors in generated IPA interface from doxygen, via #ifndef __DOXYGEN__. These constructors provide no major value in documenting them, instead will spew out doxygen warnings during the build. Signed-off-by: Umang Jain <umang.jain@ideasonboard.com> Acked-by: Kieran Bingham <kieran.bingham@ideasonboard.com> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Reviewed-by: Paul Elder <paul.elder@ideasonboard.com> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Diffstat (limited to 'utils')
-rw-r--r--utils/ipc/generators/libcamera_templates/definition_functions.tmpl3
1 files changed, 3 insertions, 0 deletions
diff --git a/utils/ipc/generators/libcamera_templates/definition_functions.tmpl b/utils/ipc/generators/libcamera_templates/definition_functions.tmpl
index cdd75f89..94bb4918 100644
--- a/utils/ipc/generators/libcamera_templates/definition_functions.tmpl
+++ b/utils/ipc/generators/libcamera_templates/definition_functions.tmpl
@@ -25,6 +25,7 @@ enum {{enum.mojom_name}} {
struct {{struct.mojom_name}}
{
public:
+#ifndef __DOXYGEN__
{{struct.mojom_name}}() {%- if struct|has_default_fields %}
:{% endif %}
{%- for field in struct.fields|with_default_values -%}
@@ -44,6 +45,8 @@ public:
{%- endfor %}
{
}
+#endif
+
{% for field in struct.fields %}
{{field|name}} {{field.mojom_name}};
{%- endfor %}