summaryrefslogtreecommitdiff
path: root/Documentation/api-html
diff options
context:
space:
mode:
authorLaurent Pinchart <laurent.pinchart@ideasonboard.com>2024-08-04 22:06:53 +0300
committerLaurent Pinchart <laurent.pinchart@ideasonboard.com>2024-08-07 17:57:07 +0300
commitff26e21339d5ae50bdb8f7bf814c6c46b19e8bf5 (patch)
tree719d887cd3b58c2b33f68f978728806fb827ef82 /Documentation/api-html
parent697bcf5b1070bb9bbda63e371c6d4ce08fda3c3d (diff)
libcamera: Hide *::Private classes with __DOXYGEN_PUBLIC__
The *::Private classes are part of the internal API, as their name implies. They are defined in internal headers, but implemented in the same source file as their public counterparts. This will cause Doxygen to complain about missing class definition when splitting the public and internal API documents, as the internal headers won't be parsed by Doxygen for the public API documentation. Marking the classes with \internal isn't enough. The directive prevents the documentation block from being included in the output, but this occurs at the generation stage, after the documentation blocks are parsed. Fix this by completely hidding the implementation of the *::Private classes from Doxygen using preprocessor conditional compilation. To do so, introduce a new macro, __DOXYGEN_PUBLIC__, that will be defined for the public API documentation only. Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Reviewed-by: Daniel Scally <dan.scally@ideasonboard.com> Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
Diffstat (limited to 'Documentation/api-html')
0 files changed, 0 insertions, 0 deletions