From 8bc88758d29cd8a73369ca62813d713517d414b7 Mon Sep 17 00:00:00 2001 From: Laurent Pinchart Date: Wed, 17 Apr 2019 12:46:03 +0300 Subject: libcamera: Document documentation style and update the code accordingly The documentation style for the Doxygen comment blocks is inconsistent in the library. Document the expectations and update all existing comment blocks to match. Signed-off-by: Laurent Pinchart Acked-by: Jacopo Mondi --- src/libcamera/geometry.cpp | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) (limited to 'src/libcamera/geometry.cpp') diff --git a/src/libcamera/geometry.cpp b/src/libcamera/geometry.cpp index d14c925a..a39b85e4 100644 --- a/src/libcamera/geometry.cpp +++ b/src/libcamera/geometry.cpp @@ -51,7 +51,6 @@ namespace libcamera { /** * \brief Assemble and return a string describing the rectangle - * * \return A string describing the Rectangle */ const std::string Rectangle::toString() const @@ -94,8 +93,8 @@ bool operator==(const Rectangle &lhs, const Rectangle &rhs) /** * \fn Size::Size(unsigned int width, unsigned int height) * \brief Construct a Size with given \a width and \a height - * \param width The Size width - * \param height The Size height + * \param[in] width The Size width + * \param[in] height The Size height */ /** @@ -191,10 +190,10 @@ bool operator<(const Size &lhs, const Size &rhs) /** * \fn SizeRange::SizeRange(unsigned int minW, unsigned int minH, unsigned int maxW, unsigned int maxH) * \brief Construct an initialized size range - * \param minW The minimum width - * \param minH The minimum height - * \param maxW The maximum width - * \param maxH The maximum height + * \param[in] minW The minimum width + * \param[in] minH The minimum height + * \param[in] maxW The maximum width + * \param[in] maxH The maximum height */ /** -- cgit v1.2.1