[gnome-builder] doc: add more snippet docs
- From: Christian Hergert <chergert src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-builder] doc: add more snippet docs
- Date: Mon, 6 Nov 2017 00:24:49 +0000 (UTC)
commit 0b37a29d8a0a1e39b0e180dfb970eac79d769bdb
Author: Christian Hergert <chergert redhat com>
Date: Sun Nov 5 16:14:14 2017 -0800
doc: add more snippet docs
src/libide/snippets/ide-source-snippet-context.c | 10 +++++++---
src/libide/snippets/ide-source-snippet-parser.c | 12 ++++++++++++
2 files changed, 19 insertions(+), 3 deletions(-)
---
diff --git a/src/libide/snippets/ide-source-snippet-context.c
b/src/libide/snippets/ide-source-snippet-context.c
index ceafb2a..456284e 100644
--- a/src/libide/snippets/ide-source-snippet-context.c
+++ b/src/libide/snippets/ide-source-snippet-context.c
@@ -16,6 +16,8 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+#define G_LOG_DOMAIN "ide-source-snippets-context"
+
#include <errno.h>
#include <glib/gi18n.h>
#include <stdlib.h>
@@ -23,17 +25,19 @@
#include "snippets/ide-source-snippet-context.h"
/**
- * SECTION:idesourcesnippetcontext:
+ * SECTION:ide-source-snippet-context
* @title: IdeSourceSnippetContext
- * @short_description: Context for expanding #IdeSourceSnippetChunk<!-- -->'s.
+ * @short_description: Context for expanding #IdeSourceSnippetChunk
*
* This class is currently used primary as a hashtable. However, the longer
* term goal is to have it hold onto a GjsContext as well as other languages
- * so that #IdeSourceSnippetChunk<!-- -->'s can expand themselves by executing
+ * so that #IdeSourceSnippetChunk can expand themselves by executing
* script within the context.
*
* The #IdeSourceSnippet will build the context and then expand each of the
* chunks during the insertion/edit phase.
+ *
+ * Since: 3.18
*/
struct _IdeSourceSnippetContext
diff --git a/src/libide/snippets/ide-source-snippet-parser.c b/src/libide/snippets/ide-source-snippet-parser.c
index e8a18e4..771cc3b 100644
--- a/src/libide/snippets/ide-source-snippet-parser.c
+++ b/src/libide/snippets/ide-source-snippet-parser.c
@@ -25,6 +25,18 @@
#include "snippets/ide-source-snippet-parser.h"
#include "snippets/ide-source-snippet-private.h"
+/**
+ * SECTION:ide-source-snippet-parser
+ * @title: IdeSourceSnippetParser
+ * @short_description: A parser for Builder's snippet text format
+ *
+ * The #IdeSourceSnippetParser can be used to parse ".snippets" formatted
+ * text files. This is generally only used internally by Builder, but can
+ * be used by plugins under certain situations.
+ *
+ * Since: 3.18
+ */
+
struct _IdeSourceSnippetParser
{
GObject parent_instance;
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]