[gnome-builder] doc: more documentation for source snippet manager
- From: Christian Hergert <chergert src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-builder] doc: more documentation for source snippet manager
- Date: Sun, 5 Nov 2017 22:54:20 +0000 (UTC)
commit 258f9e09e0a374386355dfd177df69944dded106
Author: Christian Hergert <chergert redhat com>
Date: Sun Nov 5 14:54:10 2017 -0800
doc: more documentation for source snippet manager
src/libide/snippets/ide-source-snippets-manager.c | 59 +++++++++++++++++++++
src/libide/snippets/ide-source-snippets-manager.h | 4 +-
2 files changed, 61 insertions(+), 2 deletions(-)
---
diff --git a/src/libide/snippets/ide-source-snippets-manager.c
b/src/libide/snippets/ide-source-snippets-manager.c
index fbe216e..7a47576 100644
--- a/src/libide/snippets/ide-source-snippets-manager.c
+++ b/src/libide/snippets/ide-source-snippets-manager.c
@@ -54,6 +54,8 @@
*
* |[
* snippet class
+ * - scope python, python3
+ * - desc Create a Python class
* class ${1:MyClass}(${2:object}):
* $0
* ]|
@@ -63,6 +65,63 @@
* focus once the user hits Tab. A second Tab will exhaust the edit points
* and therefore place the insertion cursor at "$0".
*
+ * You may reference other edit points as which can help in complex scenarios.
+ * In the following example, there will be a single edit point, repeated three
+ * times.
+ *
+ * |[
+ * snippet test
+ * - scope c
+ * - desc An example snippet
+ * ${1:test} $1 $1 $1 $0
+ * ]|
+ *
+ * You may also reference other edit points in the default value for an edit
+ * point. This allows you to set a value by default, but allow the user to
+ * Tab into that position and modify it.
+ *
+ * |[
+ * snippet test
+ * - scope c
+ * - desc An example snippet
+ * ${1:foo} ${2:`$1`}
+ * ]|
+ *
+ * If you want to add additional data to the edit point, you can use multiple
+ * backticks to include additional text.
+ *
+ * |[
+ * snippet test
+ * - scope c
+ * - desc An example snippet
+ * ${1:foo} ${2:`$1`_with_`$1`}
+ * ]|
+ *
+ * You can post-process the output text for an edit point by specifying a
+ * pipe "|" and then a post-processing function.
+ *
+ * Currently, the following post-processing functions are supported.
+ *
+ * - capitalize: make the input into "Captital Text"
+ * - decapitalize: make the input into "decaptital text"
+ * - html: replaces input "<>" into &lt; and &gt;
+ * - functify: converts input into something that looks like a c_function_name
+ * - namespace: guesses a proper code namespace from the input text
+ * - upper: converts to uppercase
+ * - lower: converts to lowercase
+ * - space: converts the input text into whitespace of the same length
+ * - camelize: converts the input text into CamelCase
+ * - stripsuffix: removes a filename suffix, such as ".txt" from the input
+ * - class: guess the class name from the input text
+ * - instance: guess the instance name from the input text
+ *
+ * You may chain multiple post-processing functions together.
+ *
+ * |[
+ * snippet test
+ * ${1:some-file} ${2:$1|functify|upper}
+ * ]|
+ *
* Since: 3.18
*/
diff --git a/src/libide/snippets/ide-source-snippets-manager.h
b/src/libide/snippets/ide-source-snippets-manager.h
index 27604a9..5dbab96 100644
--- a/src/libide/snippets/ide-source-snippets-manager.h
+++ b/src/libide/snippets/ide-source-snippets-manager.h
@@ -35,9 +35,9 @@ void ide_source_snippets_manager_load_async (IdeSourceSni
gboolean ide_source_snippets_manager_load_finish (IdeSourceSnippetsManager *self,
GAsyncResult *result,
GError **error);
-IdeSourceSnippets *ide_source_snippets_manager_get_for_language (IdeSourceSnippetsManager *manager,
+IdeSourceSnippets *ide_source_snippets_manager_get_for_language (IdeSourceSnippetsManager *self,
GtkSourceLanguage *language);
-IdeSourceSnippets *ide_source_snippets_manager_get_for_language_id (IdeSourceSnippetsManager *manager,
+IdeSourceSnippets *ide_source_snippets_manager_get_for_language_id (IdeSourceSnippetsManager *self,
const gchar *language_id);
G_END_DECLS
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]