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/v4l2_subdevice.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/v4l2_subdevice.cpp')
| -rw-r--r-- | src/libcamera/v4l2_subdevice.cpp | 5 |
1 files changed, 0 insertions, 5 deletions
diff --git a/src/libcamera/v4l2_subdevice.cpp b/src/libcamera/v4l2_subdevice.cpp index 5d5b168f..eaa673e9 100644 --- a/src/libcamera/v4l2_subdevice.cpp +++ b/src/libcamera/v4l2_subdevice.cpp @@ -75,7 +75,6 @@ LOG_DEFINE_CATEGORY(V4L2Subdev) /** * \brief Assemble and return a string describing the format - * * \return A string describing the V4L2SubdeviceFormat */ const std::string V4L2SubdeviceFormat::toString() const @@ -119,7 +118,6 @@ V4L2Subdevice::~V4L2Subdevice() /** * \brief Open a V4L2 subdevice - * * \return 0 on success or a negative error code otherwise */ int V4L2Subdevice::open() @@ -175,7 +173,6 @@ void V4L2Subdevice::close() * \brief Set a crop rectangle on one of the V4L2 subdevice pads * \param[in] pad The 0-indexed pad number the rectangle is to be applied to * \param[inout] rect The rectangle describing crop target area - * * \return 0 on success or a negative error code otherwise */ int V4L2Subdevice::setCrop(unsigned int pad, Rectangle *rect) @@ -187,7 +184,6 @@ int V4L2Subdevice::setCrop(unsigned int pad, Rectangle *rect) * \brief Set a compose rectangle on one of the V4L2 subdevice pads * \param[in] pad The 0-indexed pad number the rectangle is to be applied to * \param[inout] rect The rectangle describing the compose target area - * * \return 0 on success or a negative error code otherwise */ int V4L2Subdevice::setCompose(unsigned int pad, Rectangle *rect) @@ -251,7 +247,6 @@ FormatEnum V4L2Subdevice::formats(unsigned int pad) * \brief Retrieve the image format set on one of the V4L2 subdevice pads * \param[in] pad The 0-indexed pad number the format is to be retrieved from * \param[out] format The image bus format - * * \return 0 on success or a negative error code otherwise */ int V4L2Subdevice::getFormat(unsigned int pad, V4L2SubdeviceFormat *format) |