evince r3447 - trunk/libdocument

[chpe svn gnome org]

Author: chpe
Date: Sun Feb 15 13:52:24 2009
New Revision: 3447
URL: http://svn.gnome.org/viewvc/evince?rev=3447&view=rev

Log:
More docs

Modified:
   trunk/libdocument/ev-document.c

Modified: trunk/libdocument/ev-document.c
==============================================================================
--- trunk/libdocument/ev-document.c	(original)
+++ trunk/libdocument/ev-document.c	Sun Feb 15 13:52:24 2009
@@ -96,6 +96,17 @@
 	return g_mutex_trylock (ev_document_get_fc_mutex ());
 }
 
+/**
+ * ev_document_load:
+ * @document: a #EvDocument
+ * @uri: the document's URI
+ * @error: a #GError location to store an error, or %NULL
+ *
+ * Loads @document from @uri.
+ * On failure, @error is filled in.
+ *
+ * Returns: %TRUE on success, or %FALSE on failure.
+ */
 gboolean
 ev_document_load (EvDocument  *document,
 		  const char  *uri,