[libcamera-devel,5/5] libcamera: Document the libcamera namespace
diff mbox series

Message ID 20201020000310.3008-6-laurent.pinchart@ideasonboard.com
State Accepted
Headers show
Series
  • libcamera: Miscellaneous documentation fixes
Related show

Commit Message

Laurent Pinchart Oct. 20, 2020, 12:03 a.m. UTC
The libcamera namespace has been left undefined from the start. While
the documentation doesn't bring much added value, leaving it out
confuses the most recent doxygen master branch:

include/libcamera/transform.h:16: warning: Internal inconsistency: member Identity does not belong to any container!
include/libcamera/transform.h:17: warning: Internal inconsistency: member Rot0 does not belong to any container!
include/libcamera/transform.h:18: warning: Internal inconsistency: member HFlip does not belong to any container!
include/libcamera/transform.h:19: warning: Internal inconsistency: member VFlip does not belong to any container!
include/libcamera/transform.h:20: warning: Internal inconsistency: member HVFlip does not belong to any container!
include/libcamera/transform.h:21: warning: Internal inconsistency: member Rot180 does not belong to any container!
include/libcamera/transform.h:22: warning: Internal inconsistency: member Transpose does not belong to any container!
include/libcamera/transform.h:23: warning: Internal inconsistency: member Rot270 does not belong to any container!
include/libcamera/transform.h:24: warning: Internal inconsistency: member Rot90 does not belong to any container!
include/libcamera/transform.h:26: warning: Internal inconsistency: member Rot180Transpose does not belong to any container!

Document it.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 src/libcamera/camera_manager.cpp | 3 +++
 1 file changed, 3 insertions(+)

Comments

Paul Elder Oct. 20, 2020, 3:15 a.m. UTC | #1
Hi Laurent,

On Tue, Oct 20, 2020 at 03:03:10AM +0300, Laurent Pinchart wrote:
> The libcamera namespace has been left undefined from the start. While
> the documentation doesn't bring much added value, leaving it out
> confuses the most recent doxygen master branch:

All to appease doxygen.

> include/libcamera/transform.h:16: warning: Internal inconsistency: member Identity does not belong to any container!
> include/libcamera/transform.h:17: warning: Internal inconsistency: member Rot0 does not belong to any container!
> include/libcamera/transform.h:18: warning: Internal inconsistency: member HFlip does not belong to any container!
> include/libcamera/transform.h:19: warning: Internal inconsistency: member VFlip does not belong to any container!
> include/libcamera/transform.h:20: warning: Internal inconsistency: member HVFlip does not belong to any container!
> include/libcamera/transform.h:21: warning: Internal inconsistency: member Rot180 does not belong to any container!
> include/libcamera/transform.h:22: warning: Internal inconsistency: member Transpose does not belong to any container!
> include/libcamera/transform.h:23: warning: Internal inconsistency: member Rot270 does not belong to any container!
> include/libcamera/transform.h:24: warning: Internal inconsistency: member Rot90 does not belong to any container!
> include/libcamera/transform.h:26: warning: Internal inconsistency: member Rot180Transpose does not belong to any container!
> 
> Document it.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

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

> ---
>  src/libcamera/camera_manager.cpp | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/src/libcamera/camera_manager.cpp b/src/libcamera/camera_manager.cpp
> index 756f5b2b4a03..81785f919d8b 100644
> --- a/src/libcamera/camera_manager.cpp
> +++ b/src/libcamera/camera_manager.cpp
> @@ -27,6 +27,9 @@
>   * \brief The camera manager
>   */
>  
> +/**
> + * \brief Top-level libcamera namespace
> + */
>  namespace libcamera {
>  
>  LOG_DEFINE_CATEGORY(Camera)
> -- 
> Regards,
> 
> Laurent Pinchart
> 
> _______________________________________________
> libcamera-devel mailing list
> libcamera-devel@lists.libcamera.org
> https://lists.libcamera.org/listinfo/libcamera-devel
Umang Jain Oct. 20, 2020, 3:31 a.m. UTC | #2
Hi,

On 10/20/20 8:45 AM, paul.elder@ideasonboard.com wrote:
> Hi Laurent,
>
> On Tue, Oct 20, 2020 at 03:03:10AM +0300, Laurent Pinchart wrote:
>> The libcamera namespace has been left undefined from the start. While
>> the documentation doesn't bring much added value, leaving it out
>> confuses the most recent doxygen master branch:
> All to appease doxygen.
haha, indeed. All hail Doxygen!
>
>> include/libcamera/transform.h:16: warning: Internal inconsistency: member Identity does not belong to any container!
>> include/libcamera/transform.h:17: warning: Internal inconsistency: member Rot0 does not belong to any container!
>> include/libcamera/transform.h:18: warning: Internal inconsistency: member HFlip does not belong to any container!
>> include/libcamera/transform.h:19: warning: Internal inconsistency: member VFlip does not belong to any container!
>> include/libcamera/transform.h:20: warning: Internal inconsistency: member HVFlip does not belong to any container!
>> include/libcamera/transform.h:21: warning: Internal inconsistency: member Rot180 does not belong to any container!
>> include/libcamera/transform.h:22: warning: Internal inconsistency: member Transpose does not belong to any container!
>> include/libcamera/transform.h:23: warning: Internal inconsistency: member Rot270 does not belong to any container!
>> include/libcamera/transform.h:24: warning: Internal inconsistency: member Rot90 does not belong to any container!
>> include/libcamera/transform.h:26: warning: Internal inconsistency: member Rot180Transpose does not belong to any container!
>>
>> Document it.
>>
>> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> Reviewed-by: Paul Elder <paul.elder@ideasonboard.com>
Reviewed-by: Umang Jain <email@uajain.com>

Thanks!
>
>> ---
>>   src/libcamera/camera_manager.cpp | 3 +++
>>   1 file changed, 3 insertions(+)
>>
>> diff --git a/src/libcamera/camera_manager.cpp b/src/libcamera/camera_manager.cpp
>> index 756f5b2b4a03..81785f919d8b 100644
>> --- a/src/libcamera/camera_manager.cpp
>> +++ b/src/libcamera/camera_manager.cpp
>> @@ -27,6 +27,9 @@
>>    * \brief The camera manager
>>    */
>>   
>> +/**
>> + * \brief Top-level libcamera namespace
>> + */
>>   namespace libcamera {
>>   
>>   LOG_DEFINE_CATEGORY(Camera)
>> -- 
>> Regards,
>>
>> Laurent Pinchart
>>
>> _______________________________________________
>> libcamera-devel mailing list
>> libcamera-devel@lists.libcamera.org
>> https://lists.libcamera.org/listinfo/libcamera-devel
> _______________________________________________
> libcamera-devel mailing list
> libcamera-devel@lists.libcamera.org
> https://lists.libcamera.org/listinfo/libcamera-devel
Laurent Pinchart Oct. 20, 2020, 3:31 a.m. UTC | #3
On Tue, Oct 20, 2020 at 12:15:12PM +0900, paul.elder@ideasonboard.com wrote:
> Hi Laurent,
> 
> On Tue, Oct 20, 2020 at 03:03:10AM +0300, Laurent Pinchart wrote:
> > The libcamera namespace has been left undefined from the start. While
> > the documentation doesn't bring much added value, leaving it out
> > confuses the most recent doxygen master branch:
> 
> All to appease doxygen.

The life of a developer: appeasing their tools :-) When it's not doxygen
it's the compiler, and when it's not the compiler it's meson. And when
it's none of them, our SD cards blow up or our mother boards decide to
to divorce from DRAM modules. Any resemblance to developers working on
libcamera if completely intentional, I'm sure the person I'm thinking
about will recognize himself :-)

> > include/libcamera/transform.h:16: warning: Internal inconsistency: member Identity does not belong to any container!
> > include/libcamera/transform.h:17: warning: Internal inconsistency: member Rot0 does not belong to any container!
> > include/libcamera/transform.h:18: warning: Internal inconsistency: member HFlip does not belong to any container!
> > include/libcamera/transform.h:19: warning: Internal inconsistency: member VFlip does not belong to any container!
> > include/libcamera/transform.h:20: warning: Internal inconsistency: member HVFlip does not belong to any container!
> > include/libcamera/transform.h:21: warning: Internal inconsistency: member Rot180 does not belong to any container!
> > include/libcamera/transform.h:22: warning: Internal inconsistency: member Transpose does not belong to any container!
> > include/libcamera/transform.h:23: warning: Internal inconsistency: member Rot270 does not belong to any container!
> > include/libcamera/transform.h:24: warning: Internal inconsistency: member Rot90 does not belong to any container!
> > include/libcamera/transform.h:26: warning: Internal inconsistency: member Rot180Transpose does not belong to any container!
> > 
> > Document it.
> > 
> > Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> 
> Reviewed-by: Paul Elder <paul.elder@ideasonboard.com>
> 
> > ---
> >  src/libcamera/camera_manager.cpp | 3 +++
> >  1 file changed, 3 insertions(+)
> > 
> > diff --git a/src/libcamera/camera_manager.cpp b/src/libcamera/camera_manager.cpp
> > index 756f5b2b4a03..81785f919d8b 100644
> > --- a/src/libcamera/camera_manager.cpp
> > +++ b/src/libcamera/camera_manager.cpp
> > @@ -27,6 +27,9 @@
> >   * \brief The camera manager
> >   */
> >  
> > +/**
> > + * \brief Top-level libcamera namespace
> > + */
> >  namespace libcamera {
> >  
> >  LOG_DEFINE_CATEGORY(Camera)
Kieran Bingham Oct. 20, 2020, 10:39 a.m. UTC | #4
Hi Laurent,

On 20/10/2020 01:03, Laurent Pinchart wrote:
> The libcamera namespace has been left undefined from the start. While
> the documentation doesn't bring much added value, leaving it out
> confuses the most recent doxygen master branch:
> 
> include/libcamera/transform.h:16: warning: Internal inconsistency: member Identity does not belong to any container!
> include/libcamera/transform.h:17: warning: Internal inconsistency: member Rot0 does not belong to any container!
> include/libcamera/transform.h:18: warning: Internal inconsistency: member HFlip does not belong to any container!
> include/libcamera/transform.h:19: warning: Internal inconsistency: member VFlip does not belong to any container!
> include/libcamera/transform.h:20: warning: Internal inconsistency: member HVFlip does not belong to any container!
> include/libcamera/transform.h:21: warning: Internal inconsistency: member Rot180 does not belong to any container!
> include/libcamera/transform.h:22: warning: Internal inconsistency: member Transpose does not belong to any container!
> include/libcamera/transform.h:23: warning: Internal inconsistency: member Rot270 does not belong to any container!
> include/libcamera/transform.h:24: warning: Internal inconsistency: member Rot90 does not belong to any container!
> include/libcamera/transform.h:26: warning: Internal inconsistency: member Rot180Transpose does not belong to any container!
> 
> Document it.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> ---
>  src/libcamera/camera_manager.cpp | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/src/libcamera/camera_manager.cpp b/src/libcamera/camera_manager.cpp
> index 756f5b2b4a03..81785f919d8b 100644
> --- a/src/libcamera/camera_manager.cpp
> +++ b/src/libcamera/camera_manager.cpp
> @@ -27,6 +27,9 @@
>   * \brief The camera manager
>   */
>  
> +/**
> + * \brief Top-level libcamera namespace
> + */

Phew, I was preparing myself to read a 10 page novel.

I can handle one line ;-)

hehe.

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

>  namespace libcamera {
>  
>  LOG_DEFINE_CATEGORY(Camera)
>

Patch
diff mbox series

diff --git a/src/libcamera/camera_manager.cpp b/src/libcamera/camera_manager.cpp
index 756f5b2b4a03..81785f919d8b 100644
--- a/src/libcamera/camera_manager.cpp
+++ b/src/libcamera/camera_manager.cpp
@@ -27,6 +27,9 @@ 
  * \brief The camera manager
  */
 
+/**
+ * \brief Top-level libcamera namespace
+ */
 namespace libcamera {
 
 LOG_DEFINE_CATEGORY(Camera)