[PATCH libinput 3/5] tablet: Include tool with all events

[Peter Hutterer]

On Thu, Jun 26, 2014 at 02:31:20AM -0400, Stephen Chandler Paul wrote:

[...]

 diff --git a/src/libinput.h b/src/libinput.h
> index 49162dd..c6a361c 100644
> --- a/src/libinput.h
> +++ b/src/libinput.h
> @@ -918,19 +918,14 @@ libinput_event_tablet_get_y_transformed(struct libinput_event_tablet *event,
>  /**
>   * @ingroup event_tablet
>   *
> - * Returns the tool that came into proximity for this event.
> - * For tablet events that are not of type @ref
> - * LIBINPUT_EVENT_TABLET_PROXIMITY_IN, this function returns NULL. By default,
> - * the lifetime of each tool will stay valid for as long as it is being used,
> - * and is destroyed when another tool comes into proximity. However, the
> - * lifetime of the tool may be extended by using libinput_tool_ref() to
> + * Returns the tool that was in use during this event.
> + * By default, the lifetime of each tool will stay valid for as long as it is

Drop "the lifetime of" from this sentence.

Reviewed-by: Peter Hutterer <peter.hutterer at who-t.net>

Cheers,
   Peter

> + * being used, and is destroyed when another tool comes into proximity. However,
> + * the lifetime of the tool may be extended by using libinput_tool_ref() to
>   * increment the reference count of the tool. This guarantees that whenever the
>   * tool comes back into proximity of the tablet, that the same structure will be
>   * used to represent the tool.
>   *
> - * @note It is an application bug to call this function for events other than
> - * @ref LIBINPUT_EVENT_TABLET_PROXIMITY_IN.
> - *
>   * @note On tablets where the serial number of tools is not reported, each tool
>   * cannot be guaranteed to be unique.
>   *
> -- 
> 1.8.5.5
>