[libcamera-devel,v2,1/5] libcamera: geometry: Correct doxygen reference to classes
diff mbox series

Message ID 20240105164104.78398-2-dan.scally@ideasonboard.com
State Accepted
Headers show
Series
  • Improve libcamera documentation
Related show

Commit Message

Dan Scally Jan. 5, 2024, 4:41 p.m. UTC 
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.

Reviewed-by: Jacopo Mondi <jacopo.mondi@ideasonboard.com>
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Daniel Scally <dan.scally@ideasonboard.com>
---
Changes in v2:

	- None

 src/libcamera/geometry.cpp | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

Patch
diff mbox series 

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