summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKieran Bingham <kieran.bingham@ideasonboard.com>2021-04-13 11:36:40 +0100
committerKieran Bingham <kieran.bingham@ideasonboard.com>2021-04-13 20:55:40 +0100
commitc8cfa6650d6f0f665ead2070e6f2767095331084 (patch)
tree600f5adf7e62ab832c97bfb31a7dfbd5eb0336ab
parent1c9f2d7889b1e158bfac320cc270f0f9314b779e (diff)
libcamera: pipeline_handler: Document requestSequence_
The documentation for requestSequence_ was not added when the sequence number was implemented. Provide it. Fixes: d874b3e34173 ("libcamera: request: Provide a sequence number") Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
-rw-r--r--src/libcamera/pipeline_handler.cpp11
1 files changed, 11 insertions, 0 deletions
diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp
index 433c05f6..43395b57 100644
--- a/src/libcamera/pipeline_handler.cpp
+++ b/src/libcamera/pipeline_handler.cpp
@@ -98,6 +98,17 @@ LOG_DEFINE_CATEGORY(Pipeline)
*/
/**
+ * \var CameraData::requestSequence_
+ * \brief The queuing sequence of the request
+ *
+ * When requests are queued, they are given a per-camera sequence number to
+ * facilitate debugging of internal request usage.
+ *
+ * The requestSequence_ tracks the number of requests queued to a camera
+ * over its lifetime.
+ */
+
+/**
* \class PipelineHandler
* \brief Create and manage cameras based on a set of media devices
*