[libcamera-devel] libcamera: event_notifier: Fix signature typo setEnabled() in documentation

9013 diff mbox series

Signed-off-by: Umang Jain <email@uajain.com>
---
 src/libcamera/event_notifier.cpp | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Hi Umang,

On 27/07/2020 08:07, Umang Jain wrote:
> Signed-off-by: Umang Jain <email@uajain.com>

Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

> ---
>  src/libcamera/event_notifier.cpp | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/src/libcamera/event_notifier.cpp b/src/libcamera/event_notifier.cpp
> index cc3ea0d..21c07fa 100644
> --- a/src/libcamera/event_notifier.cpp
> +++ b/src/libcamera/event_notifier.cpp
> @@ -35,9 +35,9 @@ namespace libcamera {
>   * multiple event types on the same file descriptor multiple notifiers must be
>   * created.
>   *
> - * The notifier can be disabled with the setEnable() function. When the notifier
> + * The notifier can be disabled with the setEnabled() function. When the notifier
>   * is disabled it ignores events and does not emit the \ref activated signal.
> - * The notifier can then be re-enabled with the setEnable() function.
> + * The notifier can then be re-enabled with the setEnabled() function.
>   *
>   * Creating multiple notifiers of the same type for the same file descriptor is
>   * not allowed and results in undefined behaviour.
> @@ -90,7 +90,7 @@ EventNotifier::~EventNotifier()
>   * \fn EventNotifier::enabled()
>   * \brief Retrieve the notifier state
>   * \return True if the notifier is enabled, or false otherwise
> - * \sa setEnable()
> + * \sa setEnabled()
>   */
>  
>  /**
>

On Mon, Jul 27, 2020 at 10:53:59AM +0100, Kieran Bingham wrote:
> Hi Umang,
> 
> On 27/07/2020 08:07, Umang Jain wrote:
> > Signed-off-by: Umang Jain <email@uajain.com>
> 
> Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

Likewise,

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

I'll push the patch now.

> > ---
> >  src/libcamera/event_notifier.cpp | 6 +++---
> >  1 file changed, 3 insertions(+), 3 deletions(-)
> > 
> > diff --git a/src/libcamera/event_notifier.cpp b/src/libcamera/event_notifier.cpp
> > index cc3ea0d..21c07fa 100644
> > --- a/src/libcamera/event_notifier.cpp
> > +++ b/src/libcamera/event_notifier.cpp
> > @@ -35,9 +35,9 @@ namespace libcamera {
> >   * multiple event types on the same file descriptor multiple notifiers must be
> >   * created.
> >   *
> > - * The notifier can be disabled with the setEnable() function. When the notifier
> > + * The notifier can be disabled with the setEnabled() function. When the notifier
> >   * is disabled it ignores events and does not emit the \ref activated signal.
> > - * The notifier can then be re-enabled with the setEnable() function.
> > + * The notifier can then be re-enabled with the setEnabled() function.
> >   *
> >   * Creating multiple notifiers of the same type for the same file descriptor is
> >   * not allowed and results in undefined behaviour.
> > @@ -90,7 +90,7 @@ EventNotifier::~EventNotifier()
> >   * \fn EventNotifier::enabled()
> >   * \brief Retrieve the notifier state
> >   * \return True if the notifier is enabled, or false otherwise
> > - * \sa setEnable()
> > + * \sa setEnabled()
> >   */
> >  
> >  /**