[PATCH 15/15] libcamera: Drop spurious colon after doxygen \todo directive

[Stefan Klug]

Hi Laurent

Thank you for the patch. 

On Mon, Feb 24, 2025 at 01:04:03AM +0200, Laurent Pinchart wrote:
> The doxygen \todo directive doesn't need to be followed by a colon. Drop
> it. While at it, turn one 'todo:' into '\todo'.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>
> ---
>  src/ipa/libipa/awb_bayes.cpp                     | 5 +++--
>  src/ipa/rkisp1/algorithms/awb.cpp                | 2 +-
>  src/libcamera/converter/converter_v4l2_m2m.cpp   | 2 +-
>  src/libcamera/pipeline/mali-c55/mali-c55.cpp     | 2 +-
>  src/libcamera/pipeline/virtual/config_parser.cpp | 2 +-
>  5 files changed, 7 insertions(+), 6 deletions(-)
> 
> diff --git a/src/ipa/libipa/awb_bayes.cpp b/src/ipa/libipa/awb_bayes.cpp
> index d2869610a25b..c3d05e7e3413 100644
> --- a/src/ipa/libipa/awb_bayes.cpp
> +++ b/src/ipa/libipa/awb_bayes.cpp
> @@ -26,7 +26,8 @@
>   *
>   * This implementation is based on the initial implementation done by
>   * RaspberryPi.
> - * \todo: Documentation
> + *
> + * \todo Documentation
>   *
>   * \todo Not all the features implemented by RaspberryPi were ported over to
>   * this algorithm because they either rely on hardware features not generally
> @@ -272,7 +273,7 @@ void AwbBayes::handleControls(const ControlList &controls)
>  RGB<double> AwbBayes::gainsFromColourTemperature(double colourTemperature)
>  {
>  	/*
> -	 * \todo: In the RaspberryPi code, the ct curve was interpolated in
> +	 * \todo In the RaspberryPi code, the ct curve was interpolated in
>  	 * the white point space (1/x) not in gains space. This feels counter
>  	 * intuitive, as the gains are in linear space. But I can't prove it.
>  	 */
> diff --git a/src/ipa/rkisp1/algorithms/awb.cpp b/src/ipa/rkisp1/algorithms/awb.cpp
> index 3c2864fd181c..52b57ab4e3b6 100644
> --- a/src/ipa/rkisp1/algorithms/awb.cpp
> +++ b/src/ipa/rkisp1/algorithms/awb.cpp
> @@ -176,7 +176,7 @@ void Awb::queueRequest(IPAContext &context,
>  		awb.gains.manual.r() = (*colourGains)[0];
>  		awb.gains.manual.b() = (*colourGains)[1];
>  		/*
> -		 * \todo: Colour temperature reported in metadata is now
> +		 * \todo Colour temperature reported in metadata is now
>  		 * incorrect, as we can't deduce the temperature from the gains.
>  		 * This will be fixed with the bayes AWB algorithm.
>  		 */
> diff --git a/src/libcamera/converter/converter_v4l2_m2m.cpp b/src/libcamera/converter/converter_v4l2_m2m.cpp
> index 566f18ced51c..ee05b798fded 100644
> --- a/src/libcamera/converter/converter_v4l2_m2m.cpp
> +++ b/src/libcamera/converter/converter_v4l2_m2m.cpp
> @@ -738,7 +738,7 @@ int V4L2M2MConverter::queueBuffers(FrameBuffer *input,
>  }
>  
>  /*
> - * \todo: This should be extended to include Feature::Flag to denote
> + * \todo This should be extended to include Feature::Flag to denote
>   * what each converter supports feature-wise.
>   */
>  static std::initializer_list<std::string> compatibles = {
> diff --git a/src/libcamera/pipeline/mali-c55/mali-c55.cpp b/src/libcamera/pipeline/mali-c55/mali-c55.cpp
> index 5abd6b200e83..a05e11fccf8d 100644
> --- a/src/libcamera/pipeline/mali-c55/mali-c55.cpp
> +++ b/src/libcamera/pipeline/mali-c55/mali-c55.cpp
> @@ -1615,7 +1615,7 @@ bool PipelineHandlerMaliC55::registerSensorCamera(MediaLink *ispLink)
>  		isp_->frameStart.connect(data->delayedCtrls_.get(),
>  					 &DelayedControls::applyControls);
>  
> -		/* \todo: Init properties. */
> +		/* \todo Init properties. */

Oh, that's from a different patchset. Maybe we need an addition to
checkstyle :-).

Reviewed-by: Stefan Klug <stefan.klug at ideasonboard.com> 

>  
>  		if (!registerMaliCamera(std::move(data), sensor->name()))
>  			return false;
> diff --git a/src/libcamera/pipeline/virtual/config_parser.cpp b/src/libcamera/pipeline/virtual/config_parser.cpp
> index 0cbfe39bf2f0..1e009946d53b 100644
> --- a/src/libcamera/pipeline/virtual/config_parser.cpp
> +++ b/src/libcamera/pipeline/virtual/config_parser.cpp
> @@ -54,7 +54,7 @@ ConfigParser::parseConfigFile(File &file, PipelineHandler *pipe)
>  
>  		data->config_.id = cameraId;
>  		ControlInfoMap::Map controls;
> -		/* todo: Check which resolution's frame rate to be reported */
> +		/* \todo Check which resolution's frame rate to be reported */
>  		controls[&controls::FrameDurationLimits] =
>  			ControlInfo(1000000 / data->config_.resolutions[0].frameRates[1],
>  				    1000000 / data->config_.resolutions[0].frameRates[0]);
> -- 
> Regards,
> 
> Laurent Pinchart
>