PawletOS/external_libcamera
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Documentation: mainpage: Make it easier to distinguish public and internal API

Browse Source 
It might be confusing to consumers to see very similar looking doxygen
documentation with different content. Improve that by clearly stating
'public API' or 'internal API' on the main page.

Signed-off-by: Stefan Klug <stefan.klug@ideasonboard.com>
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Barnabás Pőcze <barnabas.pocze@ideasonboard.com>
This commit is contained in:
Stefan Klug
2025-09-08 16:07:48 +02:00
committed by Laurent Pinchart
parent c54eec09db
commit d317f36bd7
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
Documentation/mainpage.dox
View File

@@ -1,5 +1,9 @@
/**
\mainpage libcamera API reference
\if internal
\mainpage libcamera internal API reference
\else
\mainpage libcamera public API reference
\endif
Welcome to the API reference for <a href="https://libcamera.org/">libcamera</a>,
a complex camera support library for Linux, Android and ChromeOS. These pages