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>
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

View File

@@ -44,7 +44,7 @@ Timer::Timer()
/**
* \brief Start or restart the timer with a timeout of \a msec
* \param msec The timer duration in milliseconds
* \param[in] msec The timer duration in milliseconds
*
* If the timer is already running it will be stopped and restarted.
*/