[emerillon/gtk3] Add missing introspection annotations, improve documentation



commit c819ff4ca6860c7bca028f31b4004883152afcb3
Author: Simon Wenner <simon wenner ch>
Date:   Wed Aug 10 22:29:20 2011 +0200

    Add missing introspection annotations, improve documentation
    
    https://bugzilla.gnome.org/show_bug.cgi?id=656089

 emerillon/preferences.c |    7 +++++++
 emerillon/window.c      |   35 +++++++++++++++++++++++++++++++++--
 2 files changed, 40 insertions(+), 2 deletions(-)
---
diff --git a/emerillon/preferences.c b/emerillon/preferences.c
index 0e2ff44..35d61a8 100644
--- a/emerillon/preferences.c
+++ b/emerillon/preferences.c
@@ -102,6 +102,13 @@ emerillon_preferences_class_init (EmerillonPreferencesClass *klass)
   g_type_class_add_private (object_class, sizeof (EmerillonPreferencesPrivate));
 }
 
+/**
+ * emerillon_preferences_dup_default:
+ *
+ * Retrieves Emerillon's preferences
+ *
+ * Return value: (transfer none): A #GtkWidget containig the preferences
+ */
 GtkWidget *
 emerillon_preferences_dup_default (void)
 {
diff --git a/emerillon/window.c b/emerillon/window.c
index 9366d2e..46418ff 100644
--- a/emerillon/window.c
+++ b/emerillon/window.c
@@ -391,6 +391,13 @@ emerillon_window_class_init (EmerillonWindowClass *klass)
   g_type_class_add_private (object_class, sizeof (EmerillonWindowPrivate));
 }
 
+/**
+ * emerillon_window_dup_default:
+ *
+ * Retrieves Emerillon's main window
+ *
+ * Return value: (transfer none): A #GtkWidget
+ */
 GtkWidget *
 emerillon_window_dup_default (void)
 {
@@ -964,6 +971,14 @@ build_ui (EmerillonWindow *self)
   update_ui_visibility (self);
 }
 
+/**
+ * emerillon_window_get_map_view:
+ * @window: (in): An #EmerillonWindow instance
+ *
+ * Retrieves Emerillon's map view
+ *
+ * Return value: (transfer none): A #ChamplainView
+ */
 ChamplainView *
 emerillon_window_get_map_view  (EmerillonWindow *window)
 {
@@ -972,6 +987,14 @@ emerillon_window_get_map_view  (EmerillonWindow *window)
   return window->priv->view;
 }
 
+/**
+ * emerillon_window_get_ui_manager:
+ * @window: (in): An #EmerillonWindow instance
+ *
+ * Retrieves Emerillon's UI manager
+ *
+ * Return value: (transfer none): A #GtkUIManager
+ */
 GtkUIManager *
 emerillon_window_get_ui_manager (EmerillonWindow *window)
 {
@@ -986,7 +1009,7 @@ emerillon_window_get_ui_manager (EmerillonWindow *window)
  *
  * Retrieves Emerillon's toolbar
  *
- * Return value: A #GtkWidget containig Emerillon's toolbar
+ * Return value: (transfer none): A #GtkWidget containig Emerillon's toolbar
  */
 GtkWidget *
 emerillon_window_get_toolbar (EmerillonWindow *window)
@@ -1002,7 +1025,7 @@ emerillon_window_get_toolbar (EmerillonWindow *window)
  *
  * Retrieves Emerillon's sidebar
  *
- * Return value: A #GtkWidget containig the current sidebar
+ * Return value: (transfer none): A #GtkWidget containig the current sidebar
  */
 GtkWidget *
 emerillon_window_get_sidebar (EmerillonWindow *window)
@@ -1012,6 +1035,14 @@ emerillon_window_get_sidebar (EmerillonWindow *window)
   return window->priv->sidebar;
 }
 
+/**
+ * emerillon_window_get_statusbar:
+ * @window: (in): An #EmerillonWindow instance
+ *
+ * Retrieves Emerillon's statusbar
+ *
+ * Return value: (transfer none): A #GtkWidget containig the current statusbar
+ */
 GtkWidget *
 emerillon_window_get_statusbar (EmerillonWindow *window)
 {



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