From 2e21a2256e390cb4b6eb6ed175838bddf80934cf Mon Sep 17 00:00:00 2001 From: Daniel Boles Date: Mon, 2 Apr 2018 13:18:18 +0100 Subject: [PATCH] CellRenderer: Clarify doc of .start_editing() Drop the line copied from .activate(), replace it with a description of what this method actually does, and explain what a NULL result means. https://gitlab.gnome.org/GNOME/gtk/issues/154 --- gtk/gtkcellrenderer.c | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/gtk/gtkcellrenderer.c b/gtk/gtkcellrenderer.c index 139cb27bf6..e5c01414a7 100644 --- a/gtk/gtkcellrenderer.c +++ b/gtk/gtkcellrenderer.c @@ -892,9 +892,11 @@ gtk_cell_renderer_activate (GtkCellRenderer *cell, * @cell_area: cell area as passed to gtk_cell_renderer_render() * @flags: render flags * - * Passes an activate event to the cell renderer for possible processing. + * Starts editing the contents of this @cell, through a new #GtkCellEditable + * widget created by the #GtkCellRendererClass.start_editing virtual function. * - * Returns: (nullable) (transfer none): A new #GtkCellEditable, or %NULL + * Returns: (nullable) (transfer none): A new #GtkCellEditable for editing this + * @cell, or %NULL if editing is not possible **/ GtkCellEditable * gtk_cell_renderer_start_editing (GtkCellRenderer *cell,