From 23bacd16c348e48465f84188c84a2500ecc18002 Mon Sep 17 00:00:00 2001 From: Peter Hutterer Date: Tue, 24 May 2016 11:47:48 +1000 Subject: [PATCH] doc: update ref/unref behavior for the tablet tool Brings it in line with the rest of libinput. Signed-off-by: Peter Hutterer (cherry picked from commit 40e3fe23849e90e50c6bdb4e848b7be120c101a1) --- src/libinput.h | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/src/libinput.h b/src/libinput.h index 5b08035f..30539094 100644 --- a/src/libinput.h +++ b/src/libinput.h @@ -1889,10 +1889,13 @@ libinput_event_tablet_tool_get_y_transformed(struct libinput_event_tablet_tool * * * Returns the tool that was in use during this event. * - * If the caller holds at least one reference (see - * libinput_tablet_tool_ref()), this struct is used whenever the - * tools enters proximity. Otherwise, if no references remain when the tool - * leaves proximity, the tool may be destroyed. + * The returned tablet tool is not refcounted and may become invalid after + * the next call to libinput. Use libinput_tablet_tool_ref() and + * libinput_tablet_tool_unref() to continue using the handle outside of the + * immediate scope. + * + * If the caller holds at least one reference, this struct is used + * whenever the tools enters proximity again. * * @note Physical tool tracking requires hardware support. If unavailable, * libinput creates one tool per type per tablet. See @ref