]> www.fi.muni.cz Git - evince.git/commitdiff
More docs
authorChristian Persch <chpe@src.gnome.org>
Sun, 15 Feb 2009 13:53:18 +0000 (13:53 +0000)
committerChristian Persch <chpe@src.gnome.org>
Sun, 15 Feb 2009 13:53:18 +0000 (13:53 +0000)
svn path=/trunk/; revision=3457

libdocument/ev-document.c

index e9085bea5fd0b72d625ff22e9898f227baa99999..3356dc2e6fee364b1ff548df4ffcb1a53ebb32b5 100644 (file)
@@ -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.
  */