diff options
| author | Laurent Pinchart <laurent.pinchart@ideasonboard.com> | 2019-04-17 12:46:03 +0300 |
|---|---|---|
| committer | Laurent Pinchart <laurent.pinchart@ideasonboard.com> | 2019-04-19 13:20:46 +0300 |
| commit | 8bc88758d29cd8a73369ca62813d713517d414b7 (patch) | |
| tree | 3a1ab22e92d94c63af178e1300481c1516a8bc99 /src/libcamera/event_dispatcher.cpp | |
| parent | 0d1b60adaf0fedd21d894e4ec80e975d66753998 (diff) | |
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 <laurent.pinchart@ideasonboard.com>
Acked-by: Jacopo Mondi <jacopo@jmondi.org>
Diffstat (limited to 'src/libcamera/event_dispatcher.cpp')
| -rw-r--r-- | src/libcamera/event_dispatcher.cpp | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/src/libcamera/event_dispatcher.cpp b/src/libcamera/event_dispatcher.cpp index b82c59c3..bb4fddff 100644 --- a/src/libcamera/event_dispatcher.cpp +++ b/src/libcamera/event_dispatcher.cpp @@ -42,7 +42,7 @@ EventDispatcher::~EventDispatcher() /** * \fn EventDispatcher::registerEventNotifier() * \brief Register an event notifier - * \param notifier The event notifier to register + * \param[in] notifier The event notifier to register * * Once the \a notifier is registered with the dispatcher, the dispatcher will * emit the notifier \ref EventNotifier::activated signal whenever a @@ -57,7 +57,7 @@ EventDispatcher::~EventDispatcher() /** * \fn EventDispatcher::unregisterEventNotifier() * \brief Unregister an event notifier - * \param notifier The event notifier to unregister + * \param[in] notifier The event notifier to unregister * * After this function returns the \a notifier is guaranteed not to emit the * \ref EventNotifier::activated signal. @@ -68,7 +68,7 @@ EventDispatcher::~EventDispatcher() /** * \fn EventDispatcher::registerTimer() * \brief Register a timer - * \param timer The timer to register + * \param[in] timer The timer to register * * Once the \a timer is registered with the dispatcher, the dispatcher will emit * the timer \ref Timer::timeout signal when the timer times out. The timer can @@ -86,7 +86,7 @@ EventDispatcher::~EventDispatcher() /** * \fn EventDispatcher::unregisterTimer() * \brief Unregister a timer - * \param timer The timer to unregister + * \param[in] timer The timer to unregister * * After this function returns the \a timer is guaranteed not to emit the * \ref Timer::timeout signal. |