From: Christian Persch <chpe@src.gnome.org>
Date: Sun, 15 Feb 2009 13:53:18 +0000 (+0000)
Subject: More docs
X-Git-Tag: EVINCE_2_25_91~23
X-Git-Url: https://www.fi.muni.cz/~kas/git//home/kas/public_html/git/?a=commitdiff_plain;h=d01ad5a90562ccb83d27d0429ab33d127e36fb44;p=evince.git

More docs

svn path=/trunk/; revision=3457
---

diff --git a/libdocument/ev-document.c b/libdocument/ev-document.c
index e9085bea..3356dc2e 100644
--- a/libdocument/ev-document.c
+++ b/libdocument/ev-document.c
@@ -103,7 +103,13 @@ ev_document_fc_mutex_trylock (void)
  * @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.
  */