[libcamera-devel] libcamera: controls: Fix documentation of AwbEnable

Message ID 20191005164705.1396897-1-niklas.soderlund@ragnatech.se
State Accepted
Headers show
Series
  • [libcamera-devel] libcamera: controls: Fix documentation of AwbEnable
Related show

Commit Message

Niklas Söderlund Oct. 5, 2019, 4:47 p.m. UTC
Align the wording of the documentation for the AwbEnable control with
review comments for similar controls.

Suggested-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>
---
 src/libcamera/controls.cpp | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Laurent Pinchart Oct. 5, 2019, 4:50 p.m. UTC | #1
Hi Niklas,

Thank you for the patch.

On Sat, Oct 05, 2019 at 06:47:05PM +0200, Niklas Söderlund wrote:
> Align the wording of the documentation for the AwbEnable control with
> review comments for similar controls.
> 
> Suggested-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> Signed-off-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

> ---
>  src/libcamera/controls.cpp | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/src/libcamera/controls.cpp b/src/libcamera/controls.cpp
> index 727fdbd9450d2f40..e36410771b750fdb 100644
> --- a/src/libcamera/controls.cpp
> +++ b/src/libcamera/controls.cpp
> @@ -190,7 +190,7 @@ std::string ControlValue::toString() const
>   * \var AwbEnable
>   * ControlType: Bool
>   *
> - * Enables or disables the AWB. See also \a libcamera::ControlId::ManualGain
> + * Enable or disable the AWB. See also \a libcamera::ControlId::ManualGain
>   */
>  
>  /**

Patch

diff --git a/src/libcamera/controls.cpp b/src/libcamera/controls.cpp
index 727fdbd9450d2f40..e36410771b750fdb 100644
--- a/src/libcamera/controls.cpp
+++ b/src/libcamera/controls.cpp
@@ -190,7 +190,7 @@  std::string ControlValue::toString() const
  * \var AwbEnable
  * ControlType: Bool
  *
- * Enables or disables the AWB. See also \a libcamera::ControlId::ManualGain
+ * Enable or disable the AWB. See also \a libcamera::ControlId::ManualGain
  */
 
 /**