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

@@ -151,7 +151,6 @@ void CameraManager::stop()
/**
* \brief Get a camera based on name
*
* \param[in] name Name of camera to get
*
* Before calling this function the caller is responsible for ensuring that
@@ -229,7 +228,7 @@ CameraManager *CameraManager::instance()
/**
* \brief Set the event dispatcher
* \param dispatcher Pointer to the event dispatcher
* \param[in] dispatcher Pointer to the event dispatcher
*
* libcamera requires an event dispatcher to integrate event notification and
* timers with the application event loop. Applications that want to provide