| Message ID | 20250908140803.123272-6-stefan.klug@ideasonboard.com |
|---|---|
| State | Superseded |
| Headers | show |
| Series |
|
| Related | show |
Hi Stefan, Thank you for the patch. On Mon, Sep 08, 2025 at 04:07:48PM +0200, Stefan Klug wrote: > It might be confusion to customers 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> > --- > Documentation/mainpage.dox | 6 +++++- > 1 file changed, 5 insertions(+), 1 deletion(-) > > diff --git a/Documentation/mainpage.dox b/Documentation/mainpage.dox > index cbee9bab12ec..3f9fa24c1e14 100644 > --- a/Documentation/mainpage.dox > +++ b/Documentation/mainpage.dox > @@ -1,5 +1,9 @@ > /** > -\mainpage libcamera API reference > +\if internal > +\mainpage libcamera Internal-API reference s/-API/ API/ > +\else > +\mainpage libcamera Public-API reference Ditto. Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> > +\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
diff --git a/Documentation/mainpage.dox b/Documentation/mainpage.dox index cbee9bab12ec..3f9fa24c1e14 100644 --- a/Documentation/mainpage.dox +++ b/Documentation/mainpage.dox @@ -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
It might be confusion to customers 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> --- Documentation/mainpage.dox | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-)