PawletOS/external_libcamera
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

libcamera: Document documentation style and update the code accordingly

Browse Source 
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 <laurent.pinchart@ideasonboard.com>
Acked-by: Jacopo Mondi <jacopo@jmondi.org>
This commit is contained in:
Laurent Pinchart
2019-04-17 12:46:03 +03:00
parent 0d1b60adaf
commit 8bc88758d2
18 changed files with 116 additions and 98 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/libcamera/signal.cpp
View File

@@ -45,8 +45,8 @@ namespace libcamera {
/**
* \fn Signal::connect(T *object, void(T::*func)(Args...))
* \brief Connect the signal to a member function slot
* \param object The slot object pointer
* \param func The slot member function
* \param[in] object The slot object pointer
* \param[in] func The slot member function
*
* If the typename T inherits from Object, the signal will be automatically
* disconnected from the \a func slot of \a object when \a object is destroyed.
@@ -57,7 +57,7 @@ namespace libcamera {
/**
* \fn Signal::connect(void(*func)(Args...))
* \brief Connect the signal to a static function slot
* \param func The slot static function
* \param[in] func The slot static function
*/
/**
@@ -68,20 +68,20 @@ namespace libcamera {
/**
* \fn Signal::disconnect(T *object)
* \brief Disconnect the signal from all slots of the \a object
* \param object The object pointer whose slots to disconnect
* \param[in] object The object pointer whose slots to disconnect
*/
/**
* \fn Signal::disconnect(T *object, void(T::*func)(Args...))
* \brief Disconnect the signal from the \a object slot member function \a func
* \param object The object pointer whose slots to disconnect
* \param func The slot member function to disconnect
* \param[in] object The object pointer whose slots to disconnect
* \param[in] func The slot member function to disconnect
*/
/**
* \fn Signal::disconnect(void(*func)(Args...))
* \brief Disconnect the signal from the slot static function \a func
* \param func The slot static function to disconnect
* \param[in] func The slot static function to disconnect
*/
/**