[libcamera-devel,v2] libcamera: pipeline_handler: Hide implementation detail comment from doxygen
diff mbox series

Message ID 20210629165830.196578-1-jeanmichel.hautbois@ideasonboard.com
State Accepted
Commit 9d44551404fe0e68d4eaf087ac6fdd549434e98a
Headers show
Series
  • [libcamera-devel,v2] libcamera: pipeline_handler: Hide implementation detail comment from doxygen
Related show

Commit Message

Jean-Michel Hautbois June 29, 2021, 4:58 p.m. UTC 
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@ideasonboard.com>
Reviewed-by: Paul Elder <paul.elder@ideasonboard.com>
Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
---
 src/libcamera/pipeline_handler.cpp | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

Comments

Laurent Pinchart June 29, 2021, 9:51 p.m. UTC | #1 
Hi Jean-Michel,

On Tue, Jun 29, 2021 at 06:58:30PM +0200, Jean-Michel Hautbois wrote:
> 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@ideasonboard.com>
> Reviewed-by: Paul Elder <paul.elder@ideasonboard.com>
> Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

Looks good to me, feel free to push :-)

> ---
>  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;
>  }

Patch
diff mbox series 

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;
 }