diff options
author | Laurent Pinchart <laurent.pinchart@ideasonboard.com> | 2019-01-08 16:43:50 +0200 |
---|---|---|
committer | Laurent Pinchart <laurent.pinchart@ideasonboard.com> | 2019-01-10 15:27:59 +0200 |
commit | 93a037efff7b8afd04aad76f6b6a4514acb6f670 (patch) | |
tree | 6608b056c53e07baacee78e5ed8bf772a5026afc /src/libcamera/signal.cpp | |
parent | afcec99b99c3313805deaededa3158e4ad089b6e (diff) |
libcamera: Document missing parameters and return values
Several functions are missing documentation for some of them parameters
and/or for their return value. Fix this.
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>
Diffstat (limited to 'src/libcamera/signal.cpp')
-rw-r--r-- | src/libcamera/signal.cpp | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/src/libcamera/signal.cpp b/src/libcamera/signal.cpp index 0fd3bb2a..51536dc5 100644 --- a/src/libcamera/signal.cpp +++ b/src/libcamera/signal.cpp @@ -58,21 +58,26 @@ 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 */ /** * \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 */ /** * \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 */ /** * \fn Signal::emit(Args... args) * \brief Emit the signal and call all connected slots + * \param args The arguments passed to the connected slots * * Emitting a signal calls all connected slots synchronously and sequentially in * the order the slots have been connected. The arguments passed to the emit() |