diff options
| author | Christian Persch <chpe@src.gnome.org> | 2009-02-15 13:53:18 (GMT) |
|---|---|---|
| committer | Christian Persch <chpe@src.gnome.org> | 2009-02-15 13:53:18 (GMT) |
| commit | d01ad5a90562ccb83d27d0429ab33d127e36fb44 (patch) | |
| tree | d5d7e16cf72beed0db3ade40c44cd2ed3b23350f /libdocument | |
| parent | a5e422879ccb7b8aac50c8655671ddef55f64995 (diff) | |
More docs
svn path=/trunk/; revision=3457
Diffstat (limited to 'libdocument')
| -rw-r--r-- | libdocument/ev-document.c | 8 |
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. */ |