[gtksourceview: 5/5] view: improve docs of get_space_drawer()



commit ac8b746eb3b423c90077f069a4d9fdc3d57f4e54
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Fri Sep 30 21:21:23 2016 +0200

    view: improve docs of get_space_drawer()
    
    In the future, there will maybe be a set_space_drawer() function, for
    example to override a vfunc of SpaceDrawer and set that. Code written
    before adding the set function will still continue to work fine, so it
    will not be an API break to add the set function and remove the
    guarantee that the returned SpaceDrawer is the same.

 gtksourceview/gtksourceview.c |    6 ++++--
 1 files changed, 4 insertions(+), 2 deletions(-)
---
diff --git a/gtksourceview/gtksourceview.c b/gtksourceview/gtksourceview.c
index 8e46312..5c35043 100644
--- a/gtksourceview/gtksourceview.c
+++ b/gtksourceview/gtksourceview.c
@@ -4948,8 +4948,10 @@ gtk_source_view_get_background_pattern (GtkSourceView *view)
  * gtk_source_view_get_space_drawer:
  * @view: a #GtkSourceView.
  *
- * Returns: (transfer none) (nullable): the #GtkSourceSpaceDrawer associated
- * with @view.
+ * Returns the #GtkSourceSpaceDrawer of @view. The returned object is guaranteed
+ * to be the same for the lifetime of @view.
+ *
+ * Returns: (transfer none): the #GtkSourceSpaceDrawer associated with @view.
  * Since: 3.24
  */
 GtkSourceSpaceDrawer *


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]