NekoCWD/libcamera
NekoCWD/libcamera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 7 Wiki Activity Actions

libcamera: geometry: Correct doxygen reference to classes

Browse source 
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: Jacopo Mondi <jacopo.mondi@ideasonboard.com>
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
This commit is contained in:
Daniel Scally 2023-12-20 16:31:43 +00:00 • committed by Kieran Bingham
parent ffcd1b2804
commit effb8f5d7c
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
src/libcamera/geometry.cpp
View file

@ -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