[libcamera-devel] libcamera: Remove extra ':' after '\todo'
diff mbox series

Message ID 20220719210148.4588-1-laurent.pinchart@ideasonboard.com
State Accepted
Commit 9caee4c662e9721db2a06d1a0db24f1a677d479d
Headers show
Series
  • [libcamera-devel] libcamera: Remove extra ':' after '\todo'
Related show

Commit Message

Laurent Pinchart July 19, 2022, 9:01 p.m. UTC 
The doxygen '\todo' directory doesn't need to be followed by a colon,
yet a few strayed occurrences have made their way in. Fix them.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 include/libcamera/internal/delayed_controls.h | 2 +-
 src/ipa/ipu3/algorithms/agc.cpp               | 2 +-
 src/libcamera/camera.cpp                      | 4 ++--
 src/libcamera/controls.cpp                    | 2 +-
 src/libcamera/pipeline/ipu3/ipu3.cpp          | 2 +-
 src/libcamera/request.cpp                     | 2 +-
 6 files changed, 7 insertions(+), 7 deletions(-)


base-commit: 62e32042aee4042b6a931bc27a6ad11384b521f5

Comments

Jacopo Mondi July 20, 2022, 8:56 a.m. UTC | #1 
Hi Laurent,

On Wed, Jul 20, 2022 at 12:01:48AM +0300, Laurent Pinchart via libcamera-devel wrote:
> The doxygen '\todo' directory doesn't need to be followed by a colon,
> yet a few strayed occurrences have made their way in. Fix them.
>
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

looks good
Reviewed-by: Jacopo Mondi <jacopo@jmondi.org>

Thanks
  j

> ---
>  include/libcamera/internal/delayed_controls.h | 2 +-
>  src/ipa/ipu3/algorithms/agc.cpp               | 2 +-
>  src/libcamera/camera.cpp                      | 4 ++--
>  src/libcamera/controls.cpp                    | 2 +-
>  src/libcamera/pipeline/ipu3/ipu3.cpp          | 2 +-
>  src/libcamera/request.cpp                     | 2 +-
>  6 files changed, 7 insertions(+), 7 deletions(-)
>
> diff --git a/include/libcamera/internal/delayed_controls.h b/include/libcamera/internal/delayed_controls.h
> index f560c823d4e9..cd3ca8070278 100644
> --- a/include/libcamera/internal/delayed_controls.h
> +++ b/include/libcamera/internal/delayed_controls.h
> @@ -51,7 +51,7 @@ private:
>  		bool updated;
>  	};
>
> -	/* \todo: Make the listSize configurable at instance creation time. */
> +	/* \todo Make the listSize configurable at instance creation time. */
>  	static constexpr int listSize = 16;
>  	class ControlRingBuffer : public std::array<Info, listSize>
>  	{
> diff --git a/src/ipa/ipu3/algorithms/agc.cpp b/src/ipa/ipu3/algorithms/agc.cpp
> index f16be534dd71..5bc64ae52214 100644
> --- a/src/ipa/ipu3/algorithms/agc.cpp
> +++ b/src/ipa/ipu3/algorithms/agc.cpp
> @@ -229,7 +229,7 @@ void Agc::computeExposure(IPAContext &context, IPAFrameContext *frameContext,
>
>  	/*
>  	 * Filter the exposure.
> -	 * \todo: estimate if we need to desaturate
> +	 * \todo estimate if we need to desaturate
>  	 */
>  	exposureValue = filterExposure(exposureValue);
>
> diff --git a/src/libcamera/camera.cpp b/src/libcamera/camera.cpp
> index f8150dcdc788..2a8ef60e3862 100644
> --- a/src/libcamera/camera.cpp
> +++ b/src/libcamera/camera.cpp
> @@ -184,12 +184,12 @@ void CameraConfiguration::addConfiguration(const StreamConfiguration &cfg)
>   * This function adjusts the camera configuration to the closest valid
>   * configuration and returns the validation status.
>   *
> - * \todo: Define exactly when to return each status code. Should stream
> + * \todo Define exactly when to return each status code. Should stream
>   * parameters set to 0 by the caller be adjusted without returning Adjusted ?
>   * This would potentially be useful for applications but would get in the way
>   * in Camera::configure(). Do we need an extra status code to signal this ?
>   *
> - * \todo: Handle validation of buffers count when refactoring the buffers API.
> + * \todo Handle validation of buffers count when refactoring the buffers API.
>   *
>   * \return A CameraConfiguration::Status value that describes the validation
>   * status.
> diff --git a/src/libcamera/controls.cpp b/src/libcamera/controls.cpp
> index 03ac6345247c..840bea4b92b8 100644
> --- a/src/libcamera/controls.cpp
> +++ b/src/libcamera/controls.cpp
> @@ -908,7 +908,7 @@ ControlList::ControlList(const ControlInfoMap &infoMap,
>  void ControlList::merge(const ControlList &source)
>  {
>  	/**
> -	 * \todo: ASSERT that the current and source ControlList are derived
> +	 * \todo ASSERT that the current and source ControlList are derived
>  	 * from a compatible ControlIdMap, to prevent undefined behaviour due to
>  	 * id collisions.
>  	 *
> diff --git a/src/libcamera/pipeline/ipu3/ipu3.cpp b/src/libcamera/pipeline/ipu3/ipu3.cpp
> index d60f20b08e27..4fe52f74a68c 100644
> --- a/src/libcamera/pipeline/ipu3/ipu3.cpp
> +++ b/src/libcamera/pipeline/ipu3/ipu3.cpp
> @@ -552,7 +552,7 @@ int PipelineHandlerIPU3::configure(Camera *camera, CameraConfiguration *c)
>  		return ret;
>
>  	/*
> -	 * \todo: Enable links selectively based on the requested streams.
> +	 * \todo Enable links selectively based on the requested streams.
>  	 * As of now, enable all links unconditionally.
>  	 * \todo Don't configure the ImgU at all if we only have a single
>  	 * stream which is for raw capture, in which case no buffers will
> diff --git a/src/libcamera/request.cpp b/src/libcamera/request.cpp
> index 07613cb33709..d2af1d2212ad 100644
> --- a/src/libcamera/request.cpp
> +++ b/src/libcamera/request.cpp
> @@ -349,7 +349,7 @@ Request::Request(Camera *camera, uint64_t cookie)
>  				    camera->_d()->validator());
>
>  	/**
> -	 * \todo: Add a validator for metadata controls.
> +	 * \todo Add a validator for metadata controls.
>  	 */
>  	metadata_ = new ControlList(controls::controls);
>
>
> base-commit: 62e32042aee4042b6a931bc27a6ad11384b521f5
> --
> Regards,
>
> Laurent Pinchart
>
Nicolas Dufresne via libcamera-devel July 20, 2022, 9:11 a.m. UTC | #2 
Hi Laurent,

On Wed, Jul 20, 2022 at 12:01:48AM +0300, Laurent Pinchart via libcamera-devel wrote:
> The doxygen '\todo' directory doesn't need to be followed by a colon,
> yet a few strayed occurrences have made their way in. Fix them.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

Reviewed-by: Paul Elder <paul.elder@ideasonboard.com>

> ---
>  include/libcamera/internal/delayed_controls.h | 2 +-
>  src/ipa/ipu3/algorithms/agc.cpp               | 2 +-
>  src/libcamera/camera.cpp                      | 4 ++--
>  src/libcamera/controls.cpp                    | 2 +-
>  src/libcamera/pipeline/ipu3/ipu3.cpp          | 2 +-
>  src/libcamera/request.cpp                     | 2 +-
>  6 files changed, 7 insertions(+), 7 deletions(-)
> 
> diff --git a/include/libcamera/internal/delayed_controls.h b/include/libcamera/internal/delayed_controls.h
> index f560c823d4e9..cd3ca8070278 100644
> --- a/include/libcamera/internal/delayed_controls.h
> +++ b/include/libcamera/internal/delayed_controls.h
> @@ -51,7 +51,7 @@ private:
>  		bool updated;
>  	};
>  
> -	/* \todo: Make the listSize configurable at instance creation time. */
> +	/* \todo Make the listSize configurable at instance creation time. */
>  	static constexpr int listSize = 16;
>  	class ControlRingBuffer : public std::array<Info, listSize>
>  	{
> diff --git a/src/ipa/ipu3/algorithms/agc.cpp b/src/ipa/ipu3/algorithms/agc.cpp
> index f16be534dd71..5bc64ae52214 100644
> --- a/src/ipa/ipu3/algorithms/agc.cpp
> +++ b/src/ipa/ipu3/algorithms/agc.cpp
> @@ -229,7 +229,7 @@ void Agc::computeExposure(IPAContext &context, IPAFrameContext *frameContext,
>  
>  	/*
>  	 * Filter the exposure.
> -	 * \todo: estimate if we need to desaturate
> +	 * \todo estimate if we need to desaturate
>  	 */
>  	exposureValue = filterExposure(exposureValue);
>  
> diff --git a/src/libcamera/camera.cpp b/src/libcamera/camera.cpp
> index f8150dcdc788..2a8ef60e3862 100644
> --- a/src/libcamera/camera.cpp
> +++ b/src/libcamera/camera.cpp
> @@ -184,12 +184,12 @@ void CameraConfiguration::addConfiguration(const StreamConfiguration &cfg)
>   * This function adjusts the camera configuration to the closest valid
>   * configuration and returns the validation status.
>   *
> - * \todo: Define exactly when to return each status code. Should stream
> + * \todo Define exactly when to return each status code. Should stream
>   * parameters set to 0 by the caller be adjusted without returning Adjusted ?
>   * This would potentially be useful for applications but would get in the way
>   * in Camera::configure(). Do we need an extra status code to signal this ?
>   *
> - * \todo: Handle validation of buffers count when refactoring the buffers API.
> + * \todo Handle validation of buffers count when refactoring the buffers API.
>   *
>   * \return A CameraConfiguration::Status value that describes the validation
>   * status.
> diff --git a/src/libcamera/controls.cpp b/src/libcamera/controls.cpp
> index 03ac6345247c..840bea4b92b8 100644
> --- a/src/libcamera/controls.cpp
> +++ b/src/libcamera/controls.cpp
> @@ -908,7 +908,7 @@ ControlList::ControlList(const ControlInfoMap &infoMap,
>  void ControlList::merge(const ControlList &source)
>  {
>  	/**
> -	 * \todo: ASSERT that the current and source ControlList are derived
> +	 * \todo ASSERT that the current and source ControlList are derived
>  	 * from a compatible ControlIdMap, to prevent undefined behaviour due to
>  	 * id collisions.
>  	 *
> diff --git a/src/libcamera/pipeline/ipu3/ipu3.cpp b/src/libcamera/pipeline/ipu3/ipu3.cpp
> index d60f20b08e27..4fe52f74a68c 100644
> --- a/src/libcamera/pipeline/ipu3/ipu3.cpp
> +++ b/src/libcamera/pipeline/ipu3/ipu3.cpp
> @@ -552,7 +552,7 @@ int PipelineHandlerIPU3::configure(Camera *camera, CameraConfiguration *c)
>  		return ret;
>  
>  	/*
> -	 * \todo: Enable links selectively based on the requested streams.
> +	 * \todo Enable links selectively based on the requested streams.
>  	 * As of now, enable all links unconditionally.
>  	 * \todo Don't configure the ImgU at all if we only have a single
>  	 * stream which is for raw capture, in which case no buffers will
> diff --git a/src/libcamera/request.cpp b/src/libcamera/request.cpp
> index 07613cb33709..d2af1d2212ad 100644
> --- a/src/libcamera/request.cpp
> +++ b/src/libcamera/request.cpp
> @@ -349,7 +349,7 @@ Request::Request(Camera *camera, uint64_t cookie)
>  				    camera->_d()->validator());
>  
>  	/**
> -	 * \todo: Add a validator for metadata controls.
> +	 * \todo Add a validator for metadata controls.
>  	 */
>  	metadata_ = new ControlList(controls::controls);
>  
> 
> base-commit: 62e32042aee4042b6a931bc27a6ad11384b521f5

Patch
diff mbox series 

diff --git a/include/libcamera/internal/delayed_controls.h b/include/libcamera/internal/delayed_controls.h
index f560c823d4e9..cd3ca8070278 100644
--- a/include/libcamera/internal/delayed_controls.h
+++ b/include/libcamera/internal/delayed_controls.h
@@ -51,7 +51,7 @@  private:
 		bool updated;
 	};
 
-	/* \todo: Make the listSize configurable at instance creation time. */
+	/* \todo Make the listSize configurable at instance creation time. */
 	static constexpr int listSize = 16;
 	class ControlRingBuffer : public std::array<Info, listSize>
 	{
diff --git a/src/ipa/ipu3/algorithms/agc.cpp b/src/ipa/ipu3/algorithms/agc.cpp
index f16be534dd71..5bc64ae52214 100644
--- a/src/ipa/ipu3/algorithms/agc.cpp
+++ b/src/ipa/ipu3/algorithms/agc.cpp
@@ -229,7 +229,7 @@  void Agc::computeExposure(IPAContext &context, IPAFrameContext *frameContext,
 
 	/*
 	 * Filter the exposure.
-	 * \todo: estimate if we need to desaturate
+	 * \todo estimate if we need to desaturate
 	 */
 	exposureValue = filterExposure(exposureValue);
 
diff --git a/src/libcamera/camera.cpp b/src/libcamera/camera.cpp
index f8150dcdc788..2a8ef60e3862 100644
--- a/src/libcamera/camera.cpp
+++ b/src/libcamera/camera.cpp
@@ -184,12 +184,12 @@  void CameraConfiguration::addConfiguration(const StreamConfiguration &cfg)
  * This function adjusts the camera configuration to the closest valid
  * configuration and returns the validation status.
  *
- * \todo: Define exactly when to return each status code. Should stream
+ * \todo Define exactly when to return each status code. Should stream
  * parameters set to 0 by the caller be adjusted without returning Adjusted ?
  * This would potentially be useful for applications but would get in the way
  * in Camera::configure(). Do we need an extra status code to signal this ?
  *
- * \todo: Handle validation of buffers count when refactoring the buffers API.
+ * \todo Handle validation of buffers count when refactoring the buffers API.
  *
  * \return A CameraConfiguration::Status value that describes the validation
  * status.
diff --git a/src/libcamera/controls.cpp b/src/libcamera/controls.cpp
index 03ac6345247c..840bea4b92b8 100644
--- a/src/libcamera/controls.cpp
+++ b/src/libcamera/controls.cpp
@@ -908,7 +908,7 @@  ControlList::ControlList(const ControlInfoMap &infoMap,
 void ControlList::merge(const ControlList &source)
 {
 	/**
-	 * \todo: ASSERT that the current and source ControlList are derived
+	 * \todo ASSERT that the current and source ControlList are derived
 	 * from a compatible ControlIdMap, to prevent undefined behaviour due to
 	 * id collisions.
 	 *
diff --git a/src/libcamera/pipeline/ipu3/ipu3.cpp b/src/libcamera/pipeline/ipu3/ipu3.cpp
index d60f20b08e27..4fe52f74a68c 100644
--- a/src/libcamera/pipeline/ipu3/ipu3.cpp
+++ b/src/libcamera/pipeline/ipu3/ipu3.cpp
@@ -552,7 +552,7 @@  int PipelineHandlerIPU3::configure(Camera *camera, CameraConfiguration *c)
 		return ret;
 
 	/*
-	 * \todo: Enable links selectively based on the requested streams.
+	 * \todo Enable links selectively based on the requested streams.
 	 * As of now, enable all links unconditionally.
 	 * \todo Don't configure the ImgU at all if we only have a single
 	 * stream which is for raw capture, in which case no buffers will
diff --git a/src/libcamera/request.cpp b/src/libcamera/request.cpp
index 07613cb33709..d2af1d2212ad 100644
--- a/src/libcamera/request.cpp
+++ b/src/libcamera/request.cpp
@@ -349,7 +349,7 @@  Request::Request(Camera *camera, uint64_t cookie)
 				    camera->_d()->validator());
 
 	/**
-	 * \todo: Add a validator for metadata controls.
+	 * \todo Add a validator for metadata controls.
 	 */
 	metadata_ = new ControlList(controls::controls);