[libcamera-devel] libcamera: controls: Improve Control documentation grammar
diff mbox series

Message ID 20201120150021.81865-1-kieran.bingham@ideasonboard.com
State Accepted
Commit a97ba61b2d2048cdbebc0f71aae1ea5fdd64c5ac
Headers show
Series
  • [libcamera-devel] libcamera: controls: Improve Control documentation grammar
Related show

Commit Message

Kieran Bingham Nov. 20, 2020, 3 p.m. UTC
A few grammatical errors remain in the Control class documentation.
Fix them.

Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
---
 src/libcamera/controls.cpp | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Laurent Pinchart Nov. 20, 2020, 3:02 p.m. UTC | #1
Hi Kieran,

Thank you for the patch.

On Fri, Nov 20, 2020 at 03:00:21PM +0000, Kieran Bingham wrote:
> A few grammatical errors remain in the Control class documentation.
> Fix them.
> 
> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

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

> ---
>  src/libcamera/controls.cpp | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/src/libcamera/controls.cpp b/src/libcamera/controls.cpp
> index aad461121651..c58ed3946f3b 100644
> --- a/src/libcamera/controls.cpp
> +++ b/src/libcamera/controls.cpp
> @@ -437,8 +437,8 @@ void ControlValue::reserve(ControlType type, bool isArray, std::size_t numElemen
>   * the control value. See for instance how the ControlList::get() method
>   * returns a value corresponding to the type of the requested control.
>   *
> - * While this class is the main mean to refer to a control, the control
> - * identifying information are stored in the non-template base ControlId class.
> + * While this class is the main means to refer to a control, the control
> + * identifying information is stored in the non-template base ControlId class.
>   * This allows code that operates on a set of controls of different types to
>   * reference those controls through a ControlId instead of a Control. For
>   * instance, the list of controls supported by a camera is exposed as ControlId

Patch
diff mbox series

diff --git a/src/libcamera/controls.cpp b/src/libcamera/controls.cpp
index aad461121651..c58ed3946f3b 100644
--- a/src/libcamera/controls.cpp
+++ b/src/libcamera/controls.cpp
@@ -437,8 +437,8 @@  void ControlValue::reserve(ControlType type, bool isArray, std::size_t numElemen
  * the control value. See for instance how the ControlList::get() method
  * returns a value corresponding to the type of the requested control.
  *
- * While this class is the main mean to refer to a control, the control
- * identifying information are stored in the non-template base ControlId class.
+ * While this class is the main means to refer to a control, the control
+ * identifying information is stored in the non-template base ControlId class.
  * This allows code that operates on a set of controls of different types to
  * reference those controls through a ControlId instead of a Control. For
  * instance, the list of controls supported by a camera is exposed as ControlId