[v5,18/18] libcamera: camera: Hide Camera::create() from the public API
diff mbox series

Message ID 20240805143654.20870-19-laurent.pinchart@ideasonboard.com
State Accepted
Headers show
Series
  • Split libcamera documentation in public and internal APIs
Related show

Commit Message

Laurent Pinchart Aug. 5, 2024, 2:36 p.m. UTC
The Camera::create() function is internal. Hide it from the public API
documentation.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 src/libcamera/camera.cpp | 1 +
 1 file changed, 1 insertion(+)

Comments

Kieran Bingham Aug. 7, 2024, 11:36 a.m. UTC | #1
Quoting Laurent Pinchart (2024-08-05 15:36:54)
> The Camera::create() function is internal. Hide it from the public API
> documentation.

Fine with me but could also be merged with 04/18.
In fact, that already touches libcamera/camera.cpp!

Anyway, if it gets it done:


Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> ---
>  src/libcamera/camera.cpp | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/src/libcamera/camera.cpp b/src/libcamera/camera.cpp
> index aca466c9ba72..382a68f7bddd 100644
> --- a/src/libcamera/camera.cpp
> +++ b/src/libcamera/camera.cpp
> @@ -821,6 +821,7 @@ void Camera::Private::setState(State state)
>   */
>  
>  /**
> + * \internal
>   * \brief Create a camera instance
>   * \param[in] d Camera private data
>   * \param[in] id The ID of the camera device
> -- 
> Regards,
> 
> Laurent Pinchart
>
Laurent Pinchart Aug. 7, 2024, 1:53 p.m. UTC | #2
On Wed, Aug 07, 2024 at 12:36:02PM +0100, Kieran Bingham wrote:
> Quoting Laurent Pinchart (2024-08-05 15:36:54)
> > The Camera::create() function is internal. Hide it from the public API
> > documentation.
> 
> Fine with me but could also be merged with 04/18.
> In fact, that already touches libcamera/camera.cpp!

I've kept it separate to highlight the fact that we have internal
functions exposed as public members of public classes, and that we
should go through the public classes to mark such members as internal.
And then I forgot to mention it in the cover letter :-)

> Anyway, if it gets it done:
> 
> Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
> 
> > 
> > Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> > ---
> >  src/libcamera/camera.cpp | 1 +
> >  1 file changed, 1 insertion(+)
> > 
> > diff --git a/src/libcamera/camera.cpp b/src/libcamera/camera.cpp
> > index aca466c9ba72..382a68f7bddd 100644
> > --- a/src/libcamera/camera.cpp
> > +++ b/src/libcamera/camera.cpp
> > @@ -821,6 +821,7 @@ void Camera::Private::setState(State state)
> >   */
> >  
> >  /**
> > + * \internal
> >   * \brief Create a camera instance
> >   * \param[in] d Camera private data
> >   * \param[in] id The ID of the camera device

Patch
diff mbox series

diff --git a/src/libcamera/camera.cpp b/src/libcamera/camera.cpp
index aca466c9ba72..382a68f7bddd 100644
--- a/src/libcamera/camera.cpp
+++ b/src/libcamera/camera.cpp
@@ -821,6 +821,7 @@  void Camera::Private::setState(State state)
  */
 
 /**
+ * \internal
  * \brief Create a camera instance
  * \param[in] d Camera private data
  * \param[in] id The ID of the camera device