[glide] Doc and API guards for window



commit 29e2694ffda9d70e74ea6756974f8611d8ebfc9f
Author: Robert Carr <racarr Valentine localdomain>
Date:   Fri May 7 14:48:58 2010 -0400

    Doc and API guards for window

 libglide/glide-window.c |   17 +++++++++++++++++
 1 files changed, 17 insertions(+), 0 deletions(-)
---
diff --git a/libglide/glide-window.c b/libglide/glide-window.c
index fb09379..e42ae17 100644
--- a/libglide/glide-window.c
+++ b/libglide/glide-window.c
@@ -384,6 +384,14 @@ glide_window_close_document (GlideWindow *w)
   clutter_group_remove_all (CLUTTER_GROUP (w->priv->stage));
 }
 
+/**
+ * glide_window_open_document:
+ * @window: A #GlideWindow
+ * @filename: Path to the document to open.
+ *
+ * Opens the document with path @filename in @window.
+ *
+ */
 void
 glide_window_open_document (GlideWindow *window,
 			    const gchar *filename)
@@ -392,6 +400,8 @@ glide_window_open_document (GlideWindow *window,
   JsonNode *root, *slide_n;
   JsonArray *slide_array;
   JsonObject *root_obj;
+  
+  g_return_if_fail (GLIDE_IS_WINDOW (window));
 
   glide_window_set_document (window, 
 			     glide_document_new (filename));
@@ -1337,6 +1347,13 @@ glide_window_init (GlideWindow *window)
   //  g_signal_connect (window, "hide", G_CALLBACK (glide_window_hide), window);
 }
 
+/**
+ * glide_window_new:
+ *
+ * Constructs a new #GlideWindow.
+ *
+ * Return value: The newly allocated #GlideWindow.
+ */
 GlideWindow *
 glide_window_new ()
 {



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