[gnome-builder/wip/commands] commands: add some docs
- From: Christian Hergert <chergert src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-builder/wip/commands] commands: add some docs
- Date: Tue, 7 Oct 2014 10:54:07 +0000 (UTC)
commit 817ddf4f0e245ad78d9baedb58ea4bbd1057ac8b
Author: Christian Hergert <christian hergert me>
Date: Tue Oct 7 03:53:18 2014 -0700
commands: add some docs
src/commands/gb-command-manager.c | 16 ++++++++++++++++
1 files changed, 16 insertions(+), 0 deletions(-)
---
diff --git a/src/commands/gb-command-manager.c b/src/commands/gb-command-manager.c
index ba36b89..df6805b 100644
--- a/src/commands/gb-command-manager.c
+++ b/src/commands/gb-command-manager.c
@@ -103,6 +103,22 @@ gb_command_manager_parse (GbCommandManager *manager,
return ret;
}
+/**
+ * gb_command_manager_lookup:
+ * @command_text: a command string to be parsed.
+ * @parmaeters: (allow-none): optional location for parsed parameters.
+ *
+ * Looks for a command using the command text provided.
+ *
+ * If there are parameters to the function, @command_text will be parsed and
+ * the parameters converted to GVariant and placed in @command_text.
+ *
+ * If there was an error parsing or no command could be found, %NULL is
+ * returned.
+ *
+ * Returns: (transfer full): A #GbCommand that should be freed with
+ * g_object_unref() when no longer in use.
+ */
GbCommand *
gb_command_manager_lookup (GbCommandManager *manager,
const gchar *command_text,
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]