From 697bcf5b1070bb9bbda63e371c6d4ce08fda3c3d Mon Sep 17 00:00:00 2001 From: Laurent Pinchart Date: Sun, 4 Aug 2024 22:06:53 +0300 Subject: libcamera: Mark internal parts of public classes with \internal The libcamera public API exposes classes that have parts considered internal. They inherit the Extensible class, and their internal parts are split into a Private class. Those classes are defined in public API headers, and their Private counterparts are defined in internal headers sharing a common file name (in a different directory). Both headers are documented in the same source file. For instance, include/libcamera/camera.h contains the public API of the Camera class, and include/libcamera/internal/camera.h its internal counterpart. Both are documented in src/libcamera/camera.cpp. As the internal headers are not part of the public API, they need to be hidden from the future public API builds. To prepare for doing so, mark them with the \internal Doxygen directive. Hardcode the Doxygen INTERNAL_DOCS option to YES to include the internal API. This will be changed later for the public API documentation build. Signed-off-by: Laurent Pinchart Reviewed-by: Daniel Scally Reviewed-by: Kieran Bingham --- Documentation/Doxyfile.in | 1 + 1 file changed, 1 insertion(+) (limited to 'Documentation') diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in index abafcf6c..62e63968 100644 --- a/Documentation/Doxyfile.in +++ b/Documentation/Doxyfile.in @@ -17,6 +17,7 @@ EXTENSION_MAPPING = h=C++ TOC_INCLUDE_HEADINGS = 0 +INTERNAL_DOCS = YES CASE_SENSE_NAMES = YES QUIET = YES -- cgit v1.2.1