evince r3457 - trunk/libdocument

[chpe svn gnome org]

Author: chpe
Date: Sun Feb 15 13:53:18 2009
New Revision: 3457
URL: http://svn.gnome.org/viewvc/evince?rev=3457&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:53:18 2009
@@ -103,7 +103,13 @@
  * @error: a #GError location to store an error, or %NULL
  *
  * Loads @document from @uri.
- * On failure, @error is filled in.
+ * 
+ * On failure, %FALSE is returned and @error is filled in.
+ * If the document is encrypted, EV_DEFINE_ERROR_ENCRYPTED is returned.
+ * If the backend cannot load the specific document, EV_DOCUMENT_ERROR_INVALID
+ * is returned. Other errors are possible too, depending on the backend
+ * used to load the document and the URI, e.g. #GIOError, #GFileError, and
+ * #GConvertError.
  *
  * Returns: %TRUE on success, or %FALSE on failure.
  */