[emerillon] Add some documentation for the sidebar and window classes

[Łukasz Jernaś <ljernas src gnome org>]

commit 637b4bf6ca8c63ee20b9ce2a6adf40869c8ca76d
Author: Å?ukasz JernaÅ? <deejay1 srem org>
Date:   Sun May 16 16:40:09 2010 +0200

    Add some documentation for the sidebar and window classes

 emerillon/sidebar.c |   28 ++++++++++++++++++++++++++++
 emerillon/window.c  |   19 ++++++++++++++++++-
 2 files changed, 46 insertions(+), 1 deletions(-)
---
diff --git a/emerillon/sidebar.c b/emerillon/sidebar.c
index 03759f9..4d3719d 100644
--- a/emerillon/sidebar.c
+++ b/emerillon/sidebar.c
@@ -486,6 +486,16 @@ emerillon_sidebar_new (void)
   return sidebar;
 }
 
+/**
+ * emerillon_sidebar_add_page:
+ * @sidebar: (in): An #EmerillonSidebar instance
+ * @title: (in): Sidebar title
+ * @main_widget: (in): A #GtkWidget which should be embedded in the sidebar
+ *
+ * Adds a new page to the sidebar
+ *
+ * See: emerillon_window_get_sidebar()
+ */
 void
 emerillon_sidebar_add_page (EmerillonSidebar *sidebar,
                              const gchar *title,
@@ -616,6 +626,15 @@ emerillon_sidebar_remove_page (EmerillonSidebar *sidebar,
     }
 }
 
+/**
+ * emerillon_sidebar_get_n_pages:
+ * @sidebar: (in): An #EmerillonSidebar instance
+ *
+ * Returns the number of pages @sidebar has.
+ *
+ * Return value: The number of pages @sidebar has. If @sidebar isn't
+ * an #EmerillonSidebar instance this function returns #TRUE.
+ */
 gint
 emerillon_sidebar_get_n_pages (EmerillonSidebar *sidebar)
 {
@@ -625,6 +644,15 @@ emerillon_sidebar_get_n_pages (EmerillonSidebar *sidebar)
       GTK_TREE_MODEL (sidebar->priv->page_model), NULL);
 }
 
+/**
+ * emerillon_sidebar_is_empty:
+ * @sidebar: (in): An #EmerillonSidebar instance
+ *
+ * Checks if the @sidebar is empty
+ *
+ * Return value: #TRUE if @sidebar has no pages or isn't
+ * an #EmerillonSidebar instance
+ */
 gboolean
 emerillon_sidebar_is_empty (EmerillonSidebar *sidebar)
 {
diff --git a/emerillon/window.c b/emerillon/window.c
index 7f4ff12..d0b855e 100644
--- a/emerillon/window.c
+++ b/emerillon/window.c
@@ -347,7 +347,8 @@ emerillon_window_class_init (EmerillonWindowClass *klass)
   /**
    * EmerillonWindow:auto-update:
    *
-   * Toggle automatic update of the map position based on geoclue data
+   * Toggle automatic update of the map position based on geoclue data.
+   * When enabled also gets the current position.
    *
    * Since 0.1.2
    */
@@ -933,6 +934,14 @@ emerillon_window_get_ui_manager (EmerillonWindow *window)
   return window->priv->ui_manager;
 }
 
+/**
+ * emerillon_window_get_toolbar:
+ * @window: (in): An #EmerillonWindow instance
+ *
+ * Retrieves Emerillon's toolbar
+ *
+ * Return value: A #GtkWidget containig Emerillon's toolbar
+ */
 GtkWidget *
 emerillon_window_get_toolbar (EmerillonWindow *window)
 {
@@ -941,6 +950,14 @@ emerillon_window_get_toolbar (EmerillonWindow *window)
   return window->priv->toolbar;
 }
 
+/**
+ * emerillon_window_get_sidebar:
+ * @window: (in): An #EmerillonWindow instance
+ *
+ * Retrieves Emerillon's sidebar
+ *
+ * Return value: A #GtkWidget containig the current sidebar
+ */
 GtkWidget *
 emerillon_window_get_sidebar (EmerillonWindow *window)
 {