[libcamera-devel,6/6] libcamera: camera: Order parameter documentation correctly

Message ID 20200604134300.2986113-7-marvin.schmidt1987@gmail.com
State Superseded
Headers show
Series
  • Random documentation fixes
Related show

Commit Message

Marvin Schmidt June 4, 2020, 1:43 p.m. UTC
---
 src/libcamera/camera.cpp | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Kieran Bingham June 4, 2020, 1:54 p.m. UTC | #1
Hi Marvin,

This checks out too!

Thank you for the fixups.

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

On 04/06/2020 14:43, Marvin Schmidt wrote:
> ---
>  src/libcamera/camera.cpp | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/src/libcamera/camera.cpp b/src/libcamera/camera.cpp
> index dfc3d19..6033f47 100644
> --- a/src/libcamera/camera.cpp
> +++ b/src/libcamera/camera.cpp
> @@ -449,8 +449,8 @@ void Camera::Private::setState(State state)
>  
>  /**
>   * \brief Create a camera instance
> - * \param[in] name The name of the camera device
>   * \param[in] pipe The pipeline handler responsible for the camera device
> + * \param[in] name The name of the camera device
>   * \param[in] streams Array of streams the camera provides
>   *
>   * The caller is responsible for guaranteeing unicity of the camera name.
>
Marvin Schmidt June 5, 2020, 8:16 a.m. UTC | #2
Am Do., 4. Juni 2020 um 15:54 Uhr schrieb Kieran Bingham
<kieran.bingham@ideasonboard.com>:
>
> Hi Marvin,
>
> This checks out too!
>
> Thank you for the fixups.
>
> Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
>

Hey Kieran,

thank you for you instant review! I'm glad to help :-)

I'll add your R-b tags and send v2

> On 04/06/2020 14:43, Marvin Schmidt wrote:
> > ---
> >  src/libcamera/camera.cpp | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> >
> > diff --git a/src/libcamera/camera.cpp b/src/libcamera/camera.cpp
> > index dfc3d19..6033f47 100644
> > --- a/src/libcamera/camera.cpp
> > +++ b/src/libcamera/camera.cpp
> > @@ -449,8 +449,8 @@ void Camera::Private::setState(State state)
> >
> >  /**
> >   * \brief Create a camera instance
> > - * \param[in] name The name of the camera device
> >   * \param[in] pipe The pipeline handler responsible for the camera device
> > + * \param[in] name The name of the camera device
> >   * \param[in] streams Array of streams the camera provides
> >   *
> >   * The caller is responsible for guaranteeing unicity of the camera name.
> >
>
> --
> Regards
> --
> Kieran

Patch

diff --git a/src/libcamera/camera.cpp b/src/libcamera/camera.cpp
index dfc3d19..6033f47 100644
--- a/src/libcamera/camera.cpp
+++ b/src/libcamera/camera.cpp
@@ -449,8 +449,8 @@  void Camera::Private::setState(State state)
 
 /**
  * \brief Create a camera instance
- * \param[in] name The name of the camera device
  * \param[in] pipe The pipeline handler responsible for the camera device
+ * \param[in] name The name of the camera device
  * \param[in] streams Array of streams the camera provides
  *
  * The caller is responsible for guaranteeing unicity of the camera name.