diff options
| author | Daniel Scally <dan.scally@ideasonboard.com> | 2023-12-20 16:31:43 +0000 |
|---|---|---|
| committer | Kieran Bingham <kieran.bingham@ideasonboard.com> | 2024-01-09 15:39:04 +0000 |
| commit | effb8f5d7c468ef3e2c293c5cd5e66407108ed7a (patch) | |
| tree | 5cdc847e2e073e9f6205434662d81948c0d89f0a /src | |
| parent | ffcd1b2804bf32be0aa96c108f9b3b2bfebdfa99 (diff) | |
libcamera: geometry: Correct doxygen reference to classes
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>
Diffstat (limited to 'src')
| -rw-r--r-- | src/libcamera/geometry.cpp | 8 |
1 files 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 |