[libcamera-devel] [PATCH] libcamera: request: Fix doxygen warning

Umang Jain umang.jain at ideasonboard.com
Tue Aug 30 11:14:20 CEST 2022


Request::Private::reuse() uses \copydoc for its documentation being
copied from Request::reuse(). However, both of these functions
differs in function parameters aspect which causes doxygen to put out
a warning:

libcamera::Request::Private::reuse has @param documentation sections but no arguments

Currently doxygen has no helper section tag (like \copydetails) which
can omit the \params and just the copy the body. So for now, copy the
brief only with \copybrief to silence the warning.

Signed-off-by: Umang Jain <umang.jain at ideasonboard.com>
---
 src/libcamera/request.cpp | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/libcamera/request.cpp b/src/libcamera/request.cpp
index d2af1d22..42aa8483 100644
--- a/src/libcamera/request.cpp
+++ b/src/libcamera/request.cpp
@@ -158,7 +158,7 @@ void Request::Private::cancel()
 }
 
 /**
- * \copydoc Request::reuse()
+ * \copybrief Request::reuse()
  */
 void Request::Private::reuse()
 {
-- 
2.37.2



More information about the libcamera-devel mailing list