From 9b4990a249985d4f8238c808036d9d6b7cf81362 Mon Sep 17 00:00:00 2001 From: Kieran Bingham Date: Wed, 28 Jul 2021 09:13:54 +0100 Subject: Documentation: application-developer: Recommend unique_ptr for CameraManager The CameraManager object should be deleted when it is no longer used to prevent it from leaking. When the application closes, the memory will be released, but it would show up in reports from memory validation tools such as valgrind if not handled correctly. Recommend best-practices in the guide and ensure it is automatically cleaned up when the CameraManager goes out of scope. Signed-off-by: Kieran Bingham --- Documentation/guides/application-developer.rst | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/Documentation/guides/application-developer.rst b/Documentation/guides/application-developer.rst index 31557a60..51c8256e 100644 --- a/Documentation/guides/application-developer.rst +++ b/Documentation/guides/application-developer.rst @@ -63,9 +63,13 @@ variable for the camera to support the event call back later: Create a Camera Manager instance at the beginning of the main function, and then start it. An application should only create a single Camera Manager instance. +The CameraManager can be stored in a unique_ptr to automate deleting the +instance when it is no longer used, but care must be taken to ensure all cameras +are released explicitly. + .. code:: cpp - CameraManager *cm = new CameraManager(); + std::unique_ptr *cm = std::make_unique(); cm->start(); During the application initialization, the Camera Manager is started to @@ -560,6 +564,9 @@ uses, so needs to do the following: return 0; +In this instance the CameraManager will automatically be deleted by the +unique_ptr implementation when it goes out of scope. + Build and run instructions -------------------------- -- cgit v1.2.1