Web   ·   Wiki   ·   Activities   ·   Blog   ·   Lists   ·   Chat   ·   Meeting   ·   Bugs   ·   Git   ·   Translate   ·   Archive   ·   People   ·   Donate
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--libdocument/ev-document.c8
1 files changed, 7 insertions, 1 deletions
diff --git a/libdocument/ev-document.c b/libdocument/ev-document.c
index e9085be..3356dc2 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.
*/