| Message ID | 20231220163144.574787-1-dan.scally@ideasonboard.com |
|---|---|
| State | Accepted |
| Headers | show |
| Series |
|
| Related | show |
Hi Dan On Wed, Dec 20, 2023 at 04:31:43PM +0000, Daniel Scally via libcamera-devel wrote: > The classes Rectangle, Size and SizeRange are referenced with \struct > in the doxygen comments in geometry.cpp. Correct the reference to > \class to better reflect their definition. > > Signed-off-by: Daniel Scally <dan.scally@ideasonboard.com> Indeed! Reviewed-by: Jacopo Mondi <jacopo.mondi@ideasonboard.com> Thanks j > --- > src/libcamera/geometry.cpp | 8 ++++---- > 1 file changed, 4 insertions(+), 4 deletions(-) > > diff --git a/src/libcamera/geometry.cpp b/src/libcamera/geometry.cpp > index e50b46c5..8d85b758 100644 > --- a/src/libcamera/geometry.cpp > +++ b/src/libcamera/geometry.cpp > @@ -95,10 +95,10 @@ std::ostream &operator<<(std::ostream &out, const Point &p) > } > > /** > - * \struct Size > + * \class Size > * \brief Describe a two-dimensional size > * > - * The Size structure defines a two-dimensional size with integer precision. > + * The Size class defines a two-dimensional size with integer precision. > */ > > /** > @@ -455,7 +455,7 @@ std::ostream &operator<<(std::ostream &out, const Size &s) > } > > /** > - * \struct SizeRange > + * \class SizeRange > * \brief Describe a range of sizes > * > * A SizeRange describes a range of sizes included in the [min, max] interval > @@ -589,7 +589,7 @@ std::ostream &operator<<(std::ostream &out, const SizeRange &sr) > } > > /** > - * \struct Rectangle > + * \class Rectangle > * \brief Describe a rectangle's position and dimensions > * > * Rectangles are used to identify an area of an image. They are specified by > -- > 2.34.1 >
Hi Dan, Thank you for the patch. On Wed, Dec 20, 2023 at 04:31:43PM +0000, Daniel Scally via libcamera-devel wrote: > The classes Rectangle, Size and SizeRange are referenced with \struct > in the doxygen comments in geometry.cpp. Correct the reference to > \class to better reflect their definition. > > Signed-off-by: Daniel Scally <dan.scally@ideasonboard.com> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> > --- > src/libcamera/geometry.cpp | 8 ++++---- > 1 file changed, 4 insertions(+), 4 deletions(-) > > diff --git a/src/libcamera/geometry.cpp b/src/libcamera/geometry.cpp > index e50b46c5..8d85b758 100644 > --- a/src/libcamera/geometry.cpp > +++ b/src/libcamera/geometry.cpp > @@ -95,10 +95,10 @@ std::ostream &operator<<(std::ostream &out, const Point &p) > } > > /** > - * \struct Size > + * \class Size > * \brief Describe a two-dimensional size > * > - * The Size structure defines a two-dimensional size with integer precision. > + * The Size class defines a two-dimensional size with integer precision. > */ > > /** > @@ -455,7 +455,7 @@ std::ostream &operator<<(std::ostream &out, const Size &s) > } > > /** > - * \struct SizeRange > + * \class SizeRange > * \brief Describe a range of sizes > * > * A SizeRange describes a range of sizes included in the [min, max] interval > @@ -589,7 +589,7 @@ std::ostream &operator<<(std::ostream &out, const SizeRange &sr) > } > > /** > - * \struct Rectangle > + * \class Rectangle > * \brief Describe a rectangle's position and dimensions > * > * Rectangles are used to identify an area of an image. They are specified by
diff --git a/src/libcamera/geometry.cpp b/src/libcamera/geometry.cpp index e50b46c5..8d85b758 100644 --- a/src/libcamera/geometry.cpp +++ b/src/libcamera/geometry.cpp @@ -95,10 +95,10 @@ std::ostream &operator<<(std::ostream &out, const Point &p) } /** - * \struct Size + * \class Size * \brief Describe a two-dimensional size * - * The Size structure defines a two-dimensional size with integer precision. + * The Size class defines a two-dimensional size with integer precision. */ /** @@ -455,7 +455,7 @@ std::ostream &operator<<(std::ostream &out, const Size &s) } /** - * \struct SizeRange + * \class SizeRange * \brief Describe a range of sizes * * A SizeRange describes a range of sizes included in the [min, max] interval @@ -589,7 +589,7 @@ std::ostream &operator<<(std::ostream &out, const SizeRange &sr) } /** - * \struct Rectangle + * \class Rectangle * \brief Describe a rectangle's position and dimensions * * Rectangles are used to identify an area of an image. They are specified by
The classes Rectangle, Size and SizeRange are referenced with \struct in the doxygen comments in geometry.cpp. Correct the reference to \class to better reflect their definition. Signed-off-by: Daniel Scally <dan.scally@ideasonboard.com> --- src/libcamera/geometry.cpp | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)