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_device.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_device.cpp')
| -rw-r--r-- | src/libcamera/v4l2_device.cpp | 9 |
1 files changed, 3 insertions, 6 deletions
diff --git a/src/libcamera/v4l2_device.cpp b/src/libcamera/v4l2_device.cpp index d394632d..ccc5fbfc 100644 --- a/src/libcamera/v4l2_device.cpp +++ b/src/libcamera/v4l2_device.cpp @@ -228,7 +228,6 @@ LOG_DEFINE_CATEGORY(V4L2) /** * \brief Assemble and return a string describing the format - * * \return A string describing the V4L2DeviceFormat */ const std::string V4L2DeviceFormat::toString() const @@ -267,7 +266,7 @@ const std::string V4L2DeviceFormat::toString() const /** * \brief Construct a V4L2Device - * \param deviceNode The file-system path to the video device node + * \param[in] deviceNode The file-system path to the video device node */ V4L2Device::V4L2Device(const std::string &deviceNode) : deviceNode_(deviceNode), fd_(-1), bufferPool_(nullptr), @@ -283,7 +282,7 @@ V4L2Device::V4L2Device(const std::string &deviceNode) /** * \brief Construct a V4L2Device from a MediaEntity - * \param entity The MediaEntity to build the device from + * \param[in] entity The MediaEntity to build the device from * * Construct a V4L2Device from a MediaEntity's device node path. */ @@ -421,7 +420,6 @@ std::string V4L2Device::logPrefix() const /** * \brief Retrieve the image format set on the V4L2 device * \param[out] format The image format applied on the device - * * \return 0 on success or a negative error code otherwise */ int V4L2Device::getFormat(V4L2DeviceFormat *format) @@ -432,7 +430,7 @@ int V4L2Device::getFormat(V4L2DeviceFormat *format) /** * \brief Configure an image format on the V4L2 device - * \param[in] format The image format to apply to the device + * \param[inout] format The image format to apply to the device * * Apply the supplied \a format to the device, and return the actually * applied format parameters, as \ref V4L2Device::getFormat would do. @@ -885,7 +883,6 @@ void V4L2Device::bufferAvailable(EventNotifier *notifier) /** * \brief Start the video stream - * * \return 0 on success or a negative error code otherwise */ int V4L2Device::streamOn() |