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/media_object.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/media_object.cpp')
-rw-r--r-- | src/libcamera/media_object.cpp | 5 |
1 files changed, 2 insertions, 3 deletions
diff --git a/src/libcamera/media_object.cpp b/src/libcamera/media_object.cpp index f6abcd86..f95d7d8e 100644 --- a/src/libcamera/media_object.cpp +++ b/src/libcamera/media_object.cpp @@ -111,7 +111,7 @@ LOG_DECLARE_CATEGORY(MediaDevice) * Enabling a link establishes a data connection between two pads, while * disabling it interrupts that connection. * - * \return 0 on success, or a negative error code otherwise + * \return 0 on success or a negative error code otherwise */ int MediaLink::setEnabled(bool enable) { @@ -337,8 +337,7 @@ const MediaPad *MediaEntity::getPadById(unsigned int id) const /** * \brief Set the path to the device node for the associated interface * \param deviceNode The interface device node path associated with this entity - * \return 0 on success, or a negative error code if the device node can't be - * accessed + * \return 0 on success or a negative error code otherwise */ int MediaEntity::setDeviceNode(const std::string &deviceNode) { |