libcamera/Documentation
Laurent Pinchart 899087fe42 Documentation: Add option to treat Doxygen warnings as errors
A new Doxygen warning introduced in a recent commit went unnoticed, both
in manual tests and in CI. Unlike C/C++ warnings that are treated as
errors, we don't fail the build with Doxygen warnings. This is due to
the fact that the libcamera documentation compiles cleanly only with quite
recent versions of Doxygen. Enabling the WARN_AS_ERROR Doxygen option
unconditionally could bother many users.

To improve the situation, add a meson option to treat Doxygen warnings
as errors. The option is disabled by default, preserving the current
behaviour, and will be enabled in CI builds.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
2024-05-14 14:52:55 +03:00
..
api-html licenses: Add SPDX headers to RST documentation 2020-04-15 19:51:56 +03:00
guides guides: pipeline-handler: Fix controlInfo_ initialization 2024-03-05 10:09:41 +01:00
images/rotation Documentation: Add figures to document Orientation 2023-10-23 16:05:54 +03:00
theme Documentation: theme: Fix compilation with Sphinx >= 7.0.0 2023-07-31 22:58:58 +03:00
binning.svg Documentation: Introduce Camera Sensor Model 2023-09-27 14:35:33 +03:00
camera-sensor-model.rst Documentation: camera-sensor-model: Support Sphinx < 2.0 2024-01-09 15:35:06 +00:00
code-of-conduct.rst Documentation: contributing: Integrate the code of conduct 2023-11-25 19:01:07 +02:00
coding-style.rst Documentation: coding-style: Clean up header guard style 2024-04-17 17:11:54 +01:00
conf.py Documentation: Use language 'en' for Sphinx 5.0.0 2022-06-20 18:19:14 +02:00
contributing.rst Documentation: contributing: Integrate the code of conduct 2023-11-25 19:01:07 +02:00
docs.rst libcamera: Rename 'method' to 'function' 2021-08-09 15:40:32 +03:00
Doxyfile.in Documentation: Add option to treat Doxygen warnings as errors 2024-05-14 14:52:55 +03:00
environment_variables.rst pipeline: ipa: raspberrypi: Refactor and move the Raspberry Pi code 2023-05-04 20:47:40 +03:00
getting-started.rst Documentation: Add missing SPDX headers 2022-09-30 21:50:56 +03:00
index.rst libcamera: Add "Software ISP benchmarking" documentation 2024-04-16 13:00:21 +01:00
lens_driver_requirements.rst libcamera: camera_lens: Add a new class to model a camera lens 2021-12-03 10:23:26 +00:00
meson.build Documentation: Add option to treat Doxygen warnings as errors 2024-05-14 14:52:55 +03:00
python-bindings.rst Documentation: Fix list indentation 2023-11-28 14:08:13 +02:00
sensor_driver_requirements.rst documentation: sensor_drivers: Document H/V flip 2023-01-30 12:04:17 +01:00
sensor_model.svg Documentation: Introduce Camera Sensor Model 2023-09-27 14:35:33 +03:00
skipping.svg Documentation: Introduce Camera Sensor Model 2023-09-27 14:35:33 +03:00
software-isp-benchmarking.rst libcamera: Add "Software ISP benchmarking" documentation 2024-04-16 13:00:21 +01:00