[libcamera-devel] [PATCH v3 04/14] libcamera: camera: Fix minor issues in Camera::Private documentation

Laurent Pinchart laurent.pinchart at ideasonboard.com
Thu Aug 12 01:26:15 CEST 2021


Improve the Camera::Private documentation by fixing minor spelling or
style issues.

Signed-off-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>
---
 src/libcamera/camera.cpp | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/src/libcamera/camera.cpp b/src/libcamera/camera.cpp
index 4080da151af1..a22cc7b8e49d 100644
--- a/src/libcamera/camera.cpp
+++ b/src/libcamera/camera.cpp
@@ -368,10 +368,10 @@ Camera::Private::~Private()
 
 /**
  * \var Camera::Private::queuedRequests_
- * \brief The list of queued and not yet completed request
+ * \brief The list of queued and not yet completed requests
  *
- * The list of queued request is used to track requests queued in order to
- * ensure completion of all requests when the pipeline handler is stopped.
+ * This list tracks requests queued in order to ensure completion of all
+ * requests when the pipeline handler is stopped.
  *
  * \sa PipelineHandler::queueRequest(), PipelineHandler::stop(),
  * PipelineHandler::completeRequest()
@@ -400,7 +400,7 @@ Camera::Private::~Private()
 
 /**
  * \var Camera::Private::requestSequence_
- * \brief The queuing sequence of the request
+ * \brief The queuing sequence number of the request
  *
  * When requests are queued, they are given a per-camera sequence number to
  * facilitate debugging of internal request usage.
-- 
Regards,

Laurent Pinchart



More information about the libcamera-devel mailing list