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/pipeline/ipu3/ipu3.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/pipeline/ipu3/ipu3.cpp')
| -rw-r--r-- | src/libcamera/pipeline/ipu3/ipu3.cpp | 10 |
1 files changed, 3 insertions, 7 deletions
diff --git a/src/libcamera/pipeline/ipu3/ipu3.cpp b/src/libcamera/pipeline/ipu3/ipu3.cpp index 64b4210b..405d6548 100644 --- a/src/libcamera/pipeline/ipu3/ipu3.cpp +++ b/src/libcamera/pipeline/ipu3/ipu3.cpp @@ -613,7 +613,7 @@ int PipelineHandlerIPU3::registerCameras() /** * \brief Handle buffers completion at the ImgU input - * \param buffer The completed buffer + * \param[in] buffer The completed buffer * * Buffers completed from the ImgU input are immediately queued back to the * CIO2 unit to continue frame capture. @@ -625,7 +625,7 @@ void PipelineHandlerIPU3::IPU3CameraData::imguInputBufferReady(Buffer *buffer) /** * \brief Handle buffers completion at the ImgU output - * \param buffer The completed buffer + * \param[in] buffer The completed buffer * * Buffers completed from the ImgU output are directed to the application. */ @@ -639,7 +639,7 @@ void PipelineHandlerIPU3::IPU3CameraData::imguOutputBufferReady(Buffer *buffer) /** * \brief Handle buffers completion at the CIO2 output - * \param buffer The completed buffer + * \param[in] buffer The completed buffer * * Buffers completed from the CIO2 are immediately queued to the ImgU unit * for further processing. @@ -723,7 +723,6 @@ int ImgUDevice::init(MediaDevice *media, unsigned int index) * \brief Configure the ImgU unit input * \param[in] config The requested stream configuration * \param[in] inputFormat The format to be applied to ImgU input - * * \return 0 on success or a negative error code otherwise */ int ImgUDevice::configureInput(const StreamConfiguration &config, @@ -781,7 +780,6 @@ int ImgUDevice::configureInput(const StreamConfiguration &config, * \brief Configure the ImgU unit \a id video output * \param[in] output The ImgU output device to configure * \param[in] config The requested configuration - * * \return 0 on success or a negative error code otherwise */ int ImgUDevice::configureOutput(ImgUOutput *output, @@ -822,7 +820,6 @@ int ImgUDevice::configureOutput(ImgUOutput *output, /** * \brief Import buffers from \a pool into the ImgU input * \param[in] pool The buffer pool to import - * * \return 0 on success or a negative error code otherwise */ int ImgUDevice::importBuffers(BufferPool *pool) @@ -1082,7 +1079,6 @@ int CIO2Device::init(const MediaDevice *media, unsigned int index) * \brief Configure the CIO2 unit * \param[in] config The requested configuration * \param[out] outputFormat The CIO2 unit output image format - * * \return 0 on success or a negative error code otherwise */ int CIO2Device::configure(const StreamConfiguration &config, |