[libcamera-devel] [PATCH v2] libcamera: pipeline_handler: Hide implementation detail comment from doxygen

Jean-Michel Hautbois jeanmichel.hautbois at ideasonboard.com
Tue Jun 29 18:58:30 CEST 2021


The comment is a implementation detail and does not belong to API
documentation. Move it inside the function.

Signed-off-by: Jean-Michel Hautbois <jeanmichel.hautbois at ideasonboard.com>
Reviewed-by: Paul Elder <paul.elder at ideasonboard.com>
Reviewed-by: Kieran Bingham <kieran.bingham at ideasonboard.com>
---
 src/libcamera/pipeline_handler.cpp | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp
index f626eddd..0ed172dc 100644
--- a/src/libcamera/pipeline_handler.cpp
+++ b/src/libcamera/pipeline_handler.cpp
@@ -707,14 +707,15 @@ void PipelineHandlerFactory::registerType(PipelineHandlerFactory *factory)
 
 /**
  * \brief Retrieve the list of all pipeline handler factories
- *
- * The static factories map is defined inside the function to ensures it gets
- * initialized on first use, without any dependency on link order.
- *
  * \return the list of pipeline handler factories
  */
 std::vector<PipelineHandlerFactory *> &PipelineHandlerFactory::factories()
 {
+	/*
+	 * The static factories map is defined inside the function to ensure
+	 * it gets initialized on first use, without any dependency on
+	 * link order.
+	 */
 	static std::vector<PipelineHandlerFactory *> factories;
 	return factories;
 }
-- 
2.30.2



More information about the libcamera-devel mailing list