From f53babcd68c20f69e5f70c8253d0161d4611fd54 Mon Sep 17 00:00:00 2001 From: David Boddie Date: Wed, 31 Jul 2019 19:23:15 +0200 Subject: [PATCH] Add gtk-doc style comment --- eek/eek-renderer.c | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/eek/eek-renderer.c b/eek/eek-renderer.c index e3d8dd35..88572d2d 100644 --- a/eek/eek-renderer.c +++ b/eek/eek-renderer.c @@ -1236,10 +1236,15 @@ find_key_by_position_section_callback (EekElement *element, return data->key ? 0 : -1; } -/* - Returns the key located at the position x, y in widget coordinates, or - NULL if no key can be found at that location. -*/ +/** + * eek_renderer_find_key_by_position: + * @renderer: The renderer normally used to render the key + * @x: The horizontal widget coordinate of the position to test for a key + * @y: The vertical widget coordinate of the position to test for a key + * + * Return value: the key located at the position x, y in widget coordinates, or + * NULL if no key can be found at that location + **/ EekKey * eek_renderer_find_key_by_position (EekRenderer *renderer, gdouble x,