summaryrefslogtreecommitdiff
path: root/src/v4l2
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:06 +0300
commit697bcf5b1070bb9bbda63e371c6d4ce08fda3c3d (patch)
tree7eb144a0ed8e50997ab07b81458240fa3978c988 /src/v4l2
parentb783a9e6eebfced7c766a6afcd1fe48b71df0d15 (diff)
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 <laurent.pinchart@ideasonboard.com> Reviewed-by: Daniel Scally <dan.scally@ideasonboard.com> Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
Diffstat (limited to 'src/v4l2')
0 files changed, 0 insertions, 0 deletions