libcamera/Documentation
Umang Jain ff9276cc62 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>
2021-05-24 14:13:01 +03:00
..
api-html licenses: Add SPDX headers to RST documentation 2020-04-15 19:51:56 +03:00
guides Documentation: Fix too short title underline in ipa.rst 2021-05-13 17:24:02 +09:00
theme licenses: Add SPDX headers to the website builder and theme 2020-06-09 23:26:12 +03:00
coding-style.rst utils: checkstyle.py: Drop astyle support 2020-12-29 16:45:36 +02:00
conf.py licenses: Add SPDX headers to the website builder and theme 2020-06-09 23:26:12 +03:00
contributing.rst Documentation: contributing: Add link to bugs.libcamera.org 2021-03-25 19:34:58 +02:00
docs.rst docs: Markup LD_PRELOAD as code 2020-06-05 09:29:40 +01:00
Doxyfile.in ipa: Move core IPA interface documentation to a .cpp file 2021-05-24 14:13:01 +03:00
environment_variables.rst Documentation: environment-variables: Use standard rST link syntax 2021-03-19 01:54:41 +02:00
getting-started.rst Documentation: Add getting started section 2021-04-03 04:03:37 +03:00
index.rst Documentation: Add IPA writers guide 2021-05-13 13:20:42 +09:00
meson.build ipa: Move core IPA interface documentation to a .cpp file 2021-05-24 14:13:01 +03:00
sensor_driver_requirements.rst Documentation: sensor-driver: Fix links to V4L2 documentation 2021-03-19 01:56:33 +02:00