[libcamera-devel] libcamera: camera_manager: Document the CameraManager destructor
diff mbox series

Message ID 20210323141631.29827-1-laurent.pinchart@ideasonboard.com
State Accepted
Commit 92cad298fb7d9c459ba96cf06aa8079557e8020f
Headers show
Series
  • [libcamera-devel] libcamera: camera_manager: Document the CameraManager destructor
Related show

Commit Message

Laurent Pinchart March 23, 2021, 2:16 p.m. UTC
The destructor stops the camera manager if it is running. This is at the
moment an implementation detail, but makes sense to guarantee in the
API. Document it.

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

Comments

Sebastian Fricke March 23, 2021, 2:39 p.m. UTC | #1
Hello Laurent,

Thanks for the patch.

On 23.03.2021 16:16, Laurent Pinchart wrote:
>The destructor stops the camera manager if it is running. This is at the
>moment an implementation detail, but makes sense to guarantee in the
>API. Document it.
>
>Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
>---
> src/libcamera/camera_manager.cpp | 5 +++++
> 1 file changed, 5 insertions(+)
>
>diff --git a/src/libcamera/camera_manager.cpp b/src/libcamera/camera_manager.cpp
>index 67641a555e1e..9e4d9c391f09 100644
>--- a/src/libcamera/camera_manager.cpp
>+++ b/src/libcamera/camera_manager.cpp
>@@ -269,6 +269,11 @@ CameraManager::CameraManager()
> 	self_ = this;
> }
>
>+/**
>+ * \brief Destroy the camera manager
>+ *
>+ * Destroying the camera manager stops it if it is currently running.
>+ */
> CameraManager::~CameraManager()
> {
> 	stop();
>-- 
>Regards,

Reviewed-by: Sebastian Fricke <sebastian.fricke@posteo.net>

Greetings,
Sebastian
>
>Laurent Pinchart
>
>_______________________________________________
>libcamera-devel mailing list
>libcamera-devel@lists.libcamera.org
>https://lists.libcamera.org/listinfo/libcamera-devel
Umang Jain March 23, 2021, 2:59 p.m. UTC | #2
Hi Laurent,

On 3/23/21 8:09 PM, Sebastian Fricke wrote:
> Hello Laurent,
>
> Thanks for the patch.
>
> On 23.03.2021 16:16, Laurent Pinchart wrote:
>> The destructor stops the camera manager if it is running. This is at the
>> moment an implementation detail, but makes sense to guarantee in the
>> API. Document it.
>>
>> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Umang Jain <umang.jain@ideasonboard.com>

>> ---
>> src/libcamera/camera_manager.cpp | 5 +++++
>> 1 file changed, 5 insertions(+)
>>
>> diff --git a/src/libcamera/camera_manager.cpp 
>> b/src/libcamera/camera_manager.cpp
>> index 67641a555e1e..9e4d9c391f09 100644
>> --- a/src/libcamera/camera_manager.cpp
>> +++ b/src/libcamera/camera_manager.cpp
>> @@ -269,6 +269,11 @@ CameraManager::CameraManager()
>>     self_ = this;
>> }
>>
>> +/**
>> + * \brief Destroy the camera manager
>> + *
>> + * Destroying the camera manager stops it if it is currently running.
>> + */
>> CameraManager::~CameraManager()
>> {
>>     stop();
>> -- 
>> Regards,
>
> Reviewed-by: Sebastian Fricke <sebastian.fricke@posteo.net>
>
> Greetings,
> Sebastian
>>
>> Laurent Pinchart
>>
>> _______________________________________________
>> libcamera-devel mailing list
>> libcamera-devel@lists.libcamera.org
>> https://lists.libcamera.org/listinfo/libcamera-devel
> _______________________________________________
> libcamera-devel mailing list
> libcamera-devel@lists.libcamera.org
> https://lists.libcamera.org/listinfo/libcamera-devel
Hirokazu Honda March 24, 2021, 6:16 a.m. UTC | #3
Hi Laurent, Thanks for the patch.


On Tue, Mar 23, 2021 at 11:59 PM Umang Jain <umang.jain@ideasonboard.com> wrote:
>
> Hi Laurent,
>
> On 3/23/21 8:09 PM, Sebastian Fricke wrote:
> > Hello Laurent,
> >
> > Thanks for the patch.
> >
> > On 23.03.2021 16:16, Laurent Pinchart wrote:
> >> The destructor stops the camera manager if it is running. This is at the
> >> moment an implementation detail, but makes sense to guarantee in the
> >> API. Document it.
> >>
> >> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> Reviewed-by: Umang Jain <umang.jain@ideasonboard.com>
>
> >> ---
> >> src/libcamera/camera_manager.cpp | 5 +++++
> >> 1 file changed, 5 insertions(+)
> >>
> >> diff --git a/src/libcamera/camera_manager.cpp
> >> b/src/libcamera/camera_manager.cpp
> >> index 67641a555e1e..9e4d9c391f09 100644
> >> --- a/src/libcamera/camera_manager.cpp
> >> +++ b/src/libcamera/camera_manager.cpp
> >> @@ -269,6 +269,11 @@ CameraManager::CameraManager()
> >>     self_ = this;
> >> }
> >>
> >> +/**
> >> + * \brief Destroy the camera manager
> >> + *
> >> + * Destroying the camera manager stops it if it is currently running.
> >> + */
> >> CameraManager::~CameraManager()
> >> {
> >>     stop();
> >> --
> >> Regards,
> >
> > Reviewed-by: Sebastian Fricke <sebastian.fricke@posteo.net>
> >

Reviewed-by: Hirokazu Honda<hiroh@chromium.org>

Regards,
-Hiro
> > Greetings,
> > Sebastian
> >>
> >> Laurent Pinchart
> >>
> >> _______________________________________________
> >> libcamera-devel mailing list
> >> libcamera-devel@lists.libcamera.org
> >> https://lists.libcamera.org/listinfo/libcamera-devel
> > _______________________________________________
> > libcamera-devel mailing list
> > libcamera-devel@lists.libcamera.org
> > https://lists.libcamera.org/listinfo/libcamera-devel
>
> _______________________________________________
> libcamera-devel mailing list
> libcamera-devel@lists.libcamera.org
> https://lists.libcamera.org/listinfo/libcamera-devel
Paul Elder March 24, 2021, 9:31 a.m. UTC | #4
Hi Laurent,

On Tue, Mar 23, 2021 at 04:16:31PM +0200, Laurent Pinchart wrote:
> The destructor stops the camera manager if it is running. This is at the
> moment an implementation detail, but makes sense to guarantee in the
> API. Document it.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

Reviewed-by: Paul Elder <paul.elder@ideasonboard.com>

> ---
>  src/libcamera/camera_manager.cpp | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/src/libcamera/camera_manager.cpp b/src/libcamera/camera_manager.cpp
> index 67641a555e1e..9e4d9c391f09 100644
> --- a/src/libcamera/camera_manager.cpp
> +++ b/src/libcamera/camera_manager.cpp
> @@ -269,6 +269,11 @@ CameraManager::CameraManager()
>  	self_ = this;
>  }
>  
> +/**
> + * \brief Destroy the camera manager
> + *
> + * Destroying the camera manager stops it if it is currently running.
> + */
>  CameraManager::~CameraManager()
>  {
>  	stop();
> -- 
> Regards,
> 
> Laurent Pinchart
> 
> _______________________________________________
> libcamera-devel mailing list
> libcamera-devel@lists.libcamera.org
> https://lists.libcamera.org/listinfo/libcamera-devel

Patch
diff mbox series

diff --git a/src/libcamera/camera_manager.cpp b/src/libcamera/camera_manager.cpp
index 67641a555e1e..9e4d9c391f09 100644
--- a/src/libcamera/camera_manager.cpp
+++ b/src/libcamera/camera_manager.cpp
@@ -269,6 +269,11 @@  CameraManager::CameraManager()
 	self_ = this;
 }
 
+/**
+ * \brief Destroy the camera manager
+ *
+ * Destroying the camera manager stops it if it is currently running.
+ */
 CameraManager::~CameraManager()
 {
 	stop();