[gnome-builder] doc: update some gtk-doc



commit 6545e74a32b5e62c2f9c3aa947f3d6beb8ee0a0f
Author: Christian Hergert <christian hergert me>
Date:   Thu Jan 21 15:58:15 2016 -0800

    doc: update some gtk-doc

 doc/reference/libide/libide-docs.sgml |    1 +
 libide/ide-workbench.c                |   28 ++++++++++++++++++++++++++++
 2 files changed, 29 insertions(+), 0 deletions(-)
---
diff --git a/doc/reference/libide/libide-docs.sgml b/doc/reference/libide/libide-docs.sgml
index 61ec68b..9835f57 100644
--- a/doc/reference/libide/libide-docs.sgml
+++ b/doc/reference/libide/libide-docs.sgml
@@ -67,6 +67,7 @@
     <xi:include href="xml/ide-macros.xml"/>
     <xi:include href="xml/ide-object.xml"/>
     <xi:include href="xml/ide-pattern-spec.xml"/>
+    <xi:include href="xml/ide-perspective.xml"/>
     <xi:include href="xml/ide-process.xml"/>
     <xi:include href="xml/ide-progress.xml"/>
     <xi:include href="xml/ide-project.xml"/>
diff --git a/libide/ide-workbench.c b/libide/ide-workbench.c
index 9be73df..9459273 100644
--- a/libide/ide-workbench.c
+++ b/libide/ide-workbench.c
@@ -299,6 +299,21 @@ ide_workbench_class_init (IdeWorkbenchClass *klass)
 
   widget_class->delete_event = ide_workbench_delete_event;
 
+  /**
+   * IdeWorkbench:context:
+   *
+   * The #IdeWorkbench:context property contains the #IdeContext for the loaded
+   * project. Loading a project consists of creating an #IdeContext, so there
+   * is a 1:1 mapping between "loaded project" and an #IdeContext.
+   *
+   * The #IdeContext contains many of the important components of a project.
+   * For example, it contains the #IdeVcs representing the active version
+   * control system and an #IdeBuildSystem representing the current build
+   * system.
+   *
+   * The creation of #IdeWorkbenchAddin addins are deferred until this property
+   * has been set.
+   */
   properties [PROP_CONTEXT] =
     g_param_spec_object ("context",
                          "Context",
@@ -306,6 +321,13 @@ ide_workbench_class_init (IdeWorkbenchClass *klass)
                          IDE_TYPE_CONTEXT,
                          (G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
 
+  /**
+   * IdeWorkbench:visible-perspective:
+   *
+   * This property contains the #IdePerspective that is currently selected.
+   * Connect to the "notify::visible-perspective" signal to be notified when
+   * the perspective has been changed.
+   */
   properties [PROP_VISIBLE_PERSPECTIVE] =
     g_param_spec_object ("visible-perspective",
                          "visible-Perspective",
@@ -313,6 +335,12 @@ ide_workbench_class_init (IdeWorkbenchClass *klass)
                          IDE_TYPE_PERSPECTIVE,
                          (G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 
+  /**
+   * IdeWorkbench:visible-perspective-name:
+   *
+   * This property is just like #IdeWorkbench:visible-perspective except that
+   * it contains the name of the perspective as a string.
+   */
   properties [PROP_VISIBLE_PERSPECTIVE_NAME] =
     g_param_spec_string ("visible-perspective-name",
                          "visible-Perspective-name",


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