[libcamera-devel] [PATCH 1/2] licamera: controls: Drop unnecessary template qualifiers in documentation

Laurent Pinchart laurent.pinchart at ideasonboard.com
Tue Jul 19 23:02:57 CEST 2022


The doxygen document blocks of various ControlList function qualify
functions with full template and return type specification. This isn't
needed, and the extra verbosity makes the documentation blocks more
difficult to read. Drop the template qualifiers and return types. The
generated documentation is not affected.

Signed-off-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>
---
 src/libcamera/controls.cpp | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/src/libcamera/controls.cpp b/src/libcamera/controls.cpp
index 03ac6345247c..3fd535f204b2 100644
--- a/src/libcamera/controls.cpp
+++ b/src/libcamera/controls.cpp
@@ -954,7 +954,7 @@ bool ControlList::contains(unsigned int id) const
 }
 
 /**
- * \fn template<typename T> T ControlList::get(const Control<T> &ctrl) const
+ * \fn ControlList::get(const Control<T> &ctrl) const
  * \brief Get the value of control \a ctrl
  * \param[in] ctrl The control
  *
@@ -969,7 +969,7 @@ bool ControlList::contains(unsigned int id) const
  */
 
 /**
- * \fn template<typename T, typename V> void ControlList::set(const Control<T> &ctrl, const V &value)
+ * \fn ControlList::set(const Control<T> &ctrl, const V &value)
  * \brief Set the control \a ctrl value to \a value
  * \param[in] ctrl The control
  * \param[in] value The control value
@@ -983,8 +983,7 @@ bool ControlList::contains(unsigned int id) const
  */
 
 /**
- * \fn template<typename T, typename V> \
- * void ControlList::set(const Control<T> &ctrl, const std::initializer_list<V> &value)
+ * \fn ControlList::set(const Control<T> &ctrl, const std::initializer_list<V> &value)
  * \copydoc ControlList::set(const Control<T> &ctrl, const V &value)
  */
 

base-commit: 62e32042aee4042b6a931bc27a6ad11384b521f5
-- 
Regards,

Laurent Pinchart



More information about the libcamera-devel mailing list