diff options
| author | Niklas Söderlund <niklas.soderlund@ragnatech.se> | 2019-02-26 01:21:22 +0100 |
|---|---|---|
| committer | Niklas Söderlund <niklas.soderlund@ragnatech.se> | 2019-02-27 17:36:30 +0100 |
| commit | acb56ebef833e0189f4d867c144363ef522ba740 (patch) | |
| tree | 744d20026ba14407f5f9924a8ec380dba957b5c9 /src/libcamera/v4l2_subdevice.cpp | |
| parent | 9aceed70a2879802c7fe00ea2c0455ccd5c14f07 (diff) | |
libcamera: align the documentation for numeric error codes
Rapid growth of the library have resulted in slightly different wording
to document that a function returns 0 on success or a negative error
code otherwise. Align all different variations.
Signed-off-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>
Reviewed-by: Jacopo Mondi <jacopo@jmondi.org>
Acked-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Diffstat (limited to 'src/libcamera/v4l2_subdevice.cpp')
| -rw-r--r-- | src/libcamera/v4l2_subdevice.cpp | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/libcamera/v4l2_subdevice.cpp b/src/libcamera/v4l2_subdevice.cpp index b436f73c..d47001d4 100644 --- a/src/libcamera/v4l2_subdevice.cpp +++ b/src/libcamera/v4l2_subdevice.cpp @@ -95,7 +95,7 @@ V4L2Subdevice::V4L2Subdevice(const MediaEntity *entity) /** * \brief Open a V4L2 subdevice * - * \return 0 on success, a negative error code otherwise + * \return 0 on success or a negative error code otherwise */ int V4L2Subdevice::open() { @@ -152,7 +152,7 @@ void V4L2Subdevice::close() * \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 + * \return 0 on success or a negative error code otherwise */ int V4L2Subdevice::setCrop(unsigned int pad, Rectangle *rect) { @@ -164,7 +164,7 @@ int V4L2Subdevice::setCrop(unsigned int pad, Rectangle *rect) * \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 + * \return 0 on success or a negative error code otherwise */ int V4L2Subdevice::setCompose(unsigned int pad, Rectangle *rect) { @@ -176,7 +176,7 @@ int V4L2Subdevice::setCompose(unsigned int pad, Rectangle *rect) * \param[in] pad The 0-indexed pad number the format is to be retrieved from * \param[out] format The image bus format * - * \return 0 for success, a negative error code otherwise + * \return 0 on success or a negative error code otherwise */ int V4L2Subdevice::getFormat(unsigned int pad, V4L2SubdeviceFormat *format) { @@ -209,7 +209,7 @@ int V4L2Subdevice::getFormat(unsigned int pad, V4L2SubdeviceFormat *format) * actually applied format parameters, as \ref V4L2Subdevice::getFormat would * do. * - * \return 0 for success, a negative error code otherwise + * \return 0 on success or a negative error code otherwise */ int V4L2Subdevice::setFormat(unsigned int pad, V4L2SubdeviceFormat *format) { |