libipa: awb: Correct ~AwbStats() documentation

28161 diff mbox series

The docu-comment for AwbStats::~AwbStats() is mislabelled and so does
not build - the brief is instead embedded in the documentation for
AwbStats::computeColourError(). Correct the comment so that the
function document builds properly.

Signed-off-by: Daniel Scally <dan.scally@ideasonboard.com>
---
Doxygen doesn't complain about the missing AwbStats::~AwbStats()
documentation, but it does build it if I correct the label. The
destructor is just declared with default so there's little to
document anyway, and we could alternatively just remove this comment.
---
 src/ipa/libipa/awb.cpp | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)


---
base-commit: 1df5cbe722a839ce4e257093550fa8107c02cf8b
change-id: 20260901-awb_stat-30f178f86adb

Best regards,

On Tue, Sep 01, 2026 at 03:19:55PM +0100, Daniel Scally wrote:
> The docu-comment for AwbStats::~AwbStats() is mislabelled and so does
> not build - the brief is instead embedded in the documentation for
> AwbStats::computeColourError(). Correct the comment so that the
> function document builds properly.
> 
> Signed-off-by: Daniel Scally <dan.scally@ideasonboard.com>
> ---
> Doxygen doesn't complain about the missing AwbStats::~AwbStats()
> documentation, but it does build it if I correct the label. The
> destructor is just declared with default so there's little to
> document anyway, and we could alternatively just remove this comment.

Either way works for me, possibly with a small preference for dropping
the documentation if it doesn't cause any issue.

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

> ---
>  src/ipa/libipa/awb.cpp | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/src/ipa/libipa/awb.cpp b/src/ipa/libipa/awb.cpp
> index da835bec018d55b13200008bc24ac11db25b7bff..32a1e0045d1ba21eea6cbb8deb98ec7f629d7226 100644
> --- a/src/ipa/libipa/awb.cpp
> +++ b/src/ipa/libipa/awb.cpp
> @@ -76,7 +76,7 @@ namespace awb {
>   */
>  
>  /**
> - * AwbStat::~AwbStat
> + * \fn AwbStats::~AwbStats()
>   * \brief Virtual class destructor
>   */
>  
> ---
> base-commit: 1df5cbe722a839ce4e257093550fa8107c02cf8b
> change-id: 20260901-awb_stat-30f178f86adb

Quoting Laurent Pinchart (2026-09-01 15:47:14)
> On Tue, Sep 01, 2026 at 03:19:55PM +0100, Daniel Scally wrote:
> > The docu-comment for AwbStats::~AwbStats() is mislabelled and so does
> > not build - the brief is instead embedded in the documentation for
> > AwbStats::computeColourError(). Correct the comment so that the
> > function document builds properly.
> > 
> > Signed-off-by: Daniel Scally <dan.scally@ideasonboard.com>
> > ---
> > Doxygen doesn't complain about the missing AwbStats::~AwbStats()
> > documentation, but it does build it if I correct the label. The
> > destructor is just declared with default so there's little to
> > document anyway, and we could alternatively just remove this comment.
> 
> Either way works for me, possibly with a small preference for dropping
> the documentation if it doesn't cause any issue.
> 
> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

Indeed, documenting destructors doesn't add a lot of value.
For either solution:


Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>


> 
> > ---
> >  src/ipa/libipa/awb.cpp | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > diff --git a/src/ipa/libipa/awb.cpp b/src/ipa/libipa/awb.cpp
> > index da835bec018d55b13200008bc24ac11db25b7bff..32a1e0045d1ba21eea6cbb8deb98ec7f629d7226 100644
> > --- a/src/ipa/libipa/awb.cpp
> > +++ b/src/ipa/libipa/awb.cpp
> > @@ -76,7 +76,7 @@ namespace awb {
> >   */
> >  
> >  /**
> > - * AwbStat::~AwbStat
> > + * \fn AwbStats::~AwbStats()
> >   * \brief Virtual class destructor
> >   */
> >  
> > ---
> > base-commit: 1df5cbe722a839ce4e257093550fa8107c02cf8b
> > change-id: 20260901-awb_stat-30f178f86adb
> 
> -- 
> Regards,
> 
> Laurent Pinchart

On 01/09/2026 15:53, Kieran Bingham wrote:
> Quoting Laurent Pinchart (2026-09-01 15:47:14)
>> On Tue, Sep 01, 2026 at 03:19:55PM +0100, Daniel Scally wrote:
>>> The docu-comment for AwbStats::~AwbStats() is mislabelled and so does
>>> not build - the brief is instead embedded in the documentation for
>>> AwbStats::computeColourError(). Correct the comment so that the
>>> function document builds properly.
>>>
>>> Signed-off-by: Daniel Scally <dan.scally@ideasonboard.com>
>>> ---
>>> Doxygen doesn't complain about the missing AwbStats::~AwbStats()
>>> documentation, but it does build it if I correct the label. The
>>> destructor is just declared with default so there's little to
>>> document anyway, and we could alternatively just remove this comment.
>>
>> Either way works for me, possibly with a small preference for dropping
>> the documentation if it doesn't cause any issue.
>>
>> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> 
> Indeed, documenting destructors doesn't add a lot of value.
> For either solution:

Let's go with just dropping it then

> 
> Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

Thanks both!>
> 
>>
>>> ---
>>>   src/ipa/libipa/awb.cpp | 2 +-
>>>   1 file changed, 1 insertion(+), 1 deletion(-)
>>>
>>> diff --git a/src/ipa/libipa/awb.cpp b/src/ipa/libipa/awb.cpp
>>> index da835bec018d55b13200008bc24ac11db25b7bff..32a1e0045d1ba21eea6cbb8deb98ec7f629d7226 100644
>>> --- a/src/ipa/libipa/awb.cpp
>>> +++ b/src/ipa/libipa/awb.cpp
>>> @@ -76,7 +76,7 @@ namespace awb {
>>>    */
>>>   
>>>   /**
>>> - * AwbStat::~AwbStat
>>> + * \fn AwbStats::~AwbStats()
>>>    * \brief Virtual class destructor
>>>    */
>>>   
>>> ---
>>> base-commit: 1df5cbe722a839ce4e257093550fa8107c02cf8b
>>> change-id: 20260901-awb_stat-30f178f86adb
>>
>> -- 
>> Regards,
>>
>> Laurent Pinchart