[gnome-builder] doc: add docs for more snippets
- From: Christian Hergert <chergert src gnome org>
- To: commits-list gnome org
- Cc: 
- Subject: [gnome-builder] doc: add docs for more snippets
- Date: Mon,  6 Nov 2017 00:09:23 +0000 (UTC)
commit 19b87215478b3c79be3e548f3775fef7820e1a54
Author: Christian Hergert <chergert redhat com>
Date:   Sun Nov 5 16:09:13 2017 -0800
    doc: add docs for more snippets
 src/libide/snippets/ide-source-snippet-chunk.c |   13 +++++++++++++
 src/libide/snippets/ide-source-snippets.c      |   12 ++++++++++++
 2 files changed, 25 insertions(+), 0 deletions(-)
---
diff --git a/src/libide/snippets/ide-source-snippet-chunk.c b/src/libide/snippets/ide-source-snippet-chunk.c
index f0c5bbe..1739a14 100644
--- a/src/libide/snippets/ide-source-snippet-chunk.c
+++ b/src/libide/snippets/ide-source-snippet-chunk.c
@@ -21,6 +21,19 @@
 #include "snippets/ide-source-snippet-chunk.h"
 #include "snippets/ide-source-snippet-context.h"
 
+/**
+ * SECTION:ide-source-snippet-chunk
+ * @title: IdeSourceSnippetChunk
+ * @short_description: An chunk of text within the source snippet
+ *
+ * The #IdeSourceSnippetChunk represents a single chunk of text that
+ * may or may not be an edit point within the snippet. Chunks that are
+ * an edit point (also called a tab stop) have the
+ * #IdeSourceSnippetChunk:tab-stop property set.
+ *
+ * Since: 3.18
+ */
+
 struct _IdeSourceSnippetChunk
 {
   GObject                  parent_instance;
diff --git a/src/libide/snippets/ide-source-snippets.c b/src/libide/snippets/ide-source-snippets.c
index 18d7ae8..2b7c1eb 100644
--- a/src/libide/snippets/ide-source-snippets.c
+++ b/src/libide/snippets/ide-source-snippets.c
@@ -25,6 +25,18 @@
 #include "snippets/ide-source-snippet-parser.h"
 #include "snippets/ide-source-snippets.h"
 
+/**
+ * SECTION:ide-source-snippets
+ * @title: IdeSourceSnippets
+ * @short_description: A searchable collection of #IdeSourceSnippet
+ *
+ * The #IdeSourceSnippets object is used as a collection of #IdeSourceSnippet
+ * that can be quickly searched by prefix. This is used for fast completion
+ * of keywords in the source editor.
+ *
+ * Since: 3.18
+ */
+
 struct _IdeSourceSnippets
 {
   GObject  parent_instance;
[
Date Prev][
Date Next]   [
Thread Prev][
Thread Next]   
[
Thread Index]
[
Date Index]
[
Author Index]