From 8bc88758d29cd8a73369ca62813d713517d414b7 Mon Sep 17 00:00:00 2001 From: Laurent Pinchart Date: Wed, 17 Apr 2019 12:46:03 +0300 Subject: libcamera: Document documentation style and update the code accordingly The documentation style for the Doxygen comment blocks is inconsistent in the library. Document the expectations and update all existing comment blocks to match. Signed-off-by: Laurent Pinchart Acked-by: Jacopo Mondi --- src/libcamera/pipeline_handler.cpp | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) (limited to 'src/libcamera/pipeline_handler.cpp') diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp index 911d0844..f7a8a1ac 100644 --- a/src/libcamera/pipeline_handler.cpp +++ b/src/libcamera/pipeline_handler.cpp @@ -120,7 +120,7 @@ PipelineHandler::~PipelineHandler() /** * \fn PipelineHandler::match(DeviceEnumerator *enumerator) * \brief Match media devices and create camera instances - * \param enumerator The enumerator providing all media devices found in the + * \param[in] enumerator The enumerator providing all media devices found in the * system * * This function is the main entry point of the pipeline handler. It is called @@ -413,8 +413,7 @@ void PipelineHandler::disconnect() /** * \brief Retrieve the pipeline-specific data associated with a Camera - * \param camera The camera whose data to retrieve - * + * \param[in] camera The camera whose data to retrieve * \return A pointer to the pipeline-specific data passed to registerCamera(). * The returned pointer is a borrowed reference and is guaranteed to remain * valid until the pipeline handler is destroyed. It shall not be deleted -- cgit v1.2.1