[gtksourceview] docs: improve a little the GtkSourceBuffer doc



commit 5e10bb81a12529ba45e410910328f4e3563a5288
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Mon Sep 1 16:14:41 2014 +0200

    docs: improve a little the GtkSourceBuffer doc
    
    Reorganize the order of the functions. The class description describes
    the undo/redo and then the context classes, so apply the same order.
    Syntax highlighting is more important and is thus at the beginning.
    Marks and other functions are at the end.
    
    The generated html doesn't display the subsections. GTK-Doc could
    separate the different sections into blocks, and display the titles.

 docs/reference/gtksourceview-3.0-sections.txt |   35 +++++++++++++-----------
 gtksourceview/gtksourcebuffer.c               |    3 +-
 2 files changed, 21 insertions(+), 17 deletions(-)
---
diff --git a/docs/reference/gtksourceview-3.0-sections.txt b/docs/reference/gtksourceview-3.0-sections.txt
index 2af3b47..4b2c9e0 100644
--- a/docs/reference/gtksourceview-3.0-sections.txt
+++ b/docs/reference/gtksourceview-3.0-sections.txt
@@ -8,6 +8,7 @@ GtkSourceBracketMatchType
 GtkSourceChangeCaseType
 gtk_source_buffer_new
 gtk_source_buffer_new_with_language
+<SUBSECTION Syntax Highlighting>
 gtk_source_buffer_set_highlight_syntax
 gtk_source_buffer_get_highlight_syntax
 gtk_source_buffer_set_language
@@ -17,29 +18,31 @@ gtk_source_buffer_get_highlight_matching_brackets
 gtk_source_buffer_set_style_scheme
 gtk_source_buffer_get_style_scheme
 gtk_source_buffer_ensure_highlight
+<SUBSECTION Undo Redo>
+gtk_source_buffer_undo
+gtk_source_buffer_redo
+gtk_source_buffer_can_undo
+gtk_source_buffer_can_redo
+gtk_source_buffer_begin_not_undoable_action
+gtk_source_buffer_end_not_undoable_action
+gtk_source_buffer_get_max_undo_levels
+gtk_source_buffer_set_max_undo_levels
+gtk_source_buffer_get_undo_manager
+gtk_source_buffer_set_undo_manager
+<SUBSECTION Context Classes>
+gtk_source_buffer_iter_has_context_class
+gtk_source_buffer_get_context_classes_at_iter
+gtk_source_buffer_iter_forward_to_context_class_toggle
+gtk_source_buffer_iter_backward_to_context_class_toggle
+<SUBSECTION Marks>
 gtk_source_buffer_create_source_mark
 gtk_source_buffer_forward_iter_to_source_mark
 gtk_source_buffer_backward_iter_to_source_mark
 gtk_source_buffer_get_source_marks_at_line
 gtk_source_buffer_get_source_marks_at_iter
 gtk_source_buffer_remove_source_marks
-gtk_source_buffer_iter_has_context_class
-gtk_source_buffer_get_context_classes_at_iter
-gtk_source_buffer_iter_forward_to_context_class_toggle
-gtk_source_buffer_iter_backward_to_context_class_toggle
+<SUBSECTION Other>
 gtk_source_buffer_change_case
-<SUBSECTION>
-gtk_source_buffer_get_max_undo_levels
-gtk_source_buffer_set_max_undo_levels
-gtk_source_buffer_redo
-gtk_source_buffer_undo
-gtk_source_buffer_can_redo
-gtk_source_buffer_can_undo
-gtk_source_buffer_begin_not_undoable_action
-gtk_source_buffer_end_not_undoable_action
-gtk_source_buffer_get_undo_manager
-gtk_source_buffer_set_undo_manager
-<SUBSECTION>
 gtk_source_buffer_set_implicit_trailing_newline
 gtk_source_buffer_get_implicit_trailing_newline
 <SUBSECTION Standard>
diff --git a/gtksourceview/gtksourcebuffer.c b/gtksourceview/gtksourcebuffer.c
index 276af8b..89a13d6 100644
--- a/gtksourceview/gtksourcebuffer.c
+++ b/gtksourceview/gtksourcebuffer.c
@@ -363,7 +363,8 @@ gtk_source_buffer_class_init (GtkSourceBufferClass *klass)
        /**
         * GtkSourceBuffer:implicit-trailing-newline:
         *
-        * Whether the buffer has an implicit trailing newline.
+        * Whether the buffer has an implicit trailing newline. See
+        * gtk_source_buffer_set_implicit_trailing_newline().
         *
         * Since: 3.14
         */


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