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

More docs

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

diff --git a/libdocument/ev-document-factory.c b/libdocument/ev-document-factory.c
index 575dfb95..19a06039 100644
--- a/libdocument/ev-document-factory.c
+++ b/libdocument/ev-document-factory.c
@@ -191,6 +191,17 @@ free_uncompressed_uri (gchar *uri_unc)
 	g_free (uri_unc);
 }
 
+/**
+ * ev_document_factory_get_document:
+ * @uri: an URI
+ * @error: a #GError location to store an error, or %NULL
+ *
+ * Creates a #EvDocument for the document at @uri; or, if no backend handling
+ * the document's type is found, or an error occurred on opening the document,
+ * returns %NULL and fills in @error.
+ *
+ * Returns: a new #EvDocument, or %NULL.
+ */
 EvDocument *
 ev_document_factory_get_document (const char *uri, GError **error)
 {
@@ -311,7 +322,21 @@ file_filter_add_mime_types (EvTypeInfo *info, GtkFileFilter *filter)
 		gtk_file_filter_add_mime_type (filter, mime_type);
 }
 
-void 
+/**
+ * ev_document_factory_add_filters:
+ * @chooser: a #GtkFileChooser
+ * @document: a #EvDocument, or %NULL
+ *
+ * Adds some file filters to @chooser.
+ 
+ * Always add a "All documents" format.
+ * 
+ * If @document is not %NULL, adds a #GtkFileFilter for @document's MIME type.
+ *
+ * If @document is %NULL, adds a #GtkFileFilter for each document type that evince
+ * can handle.
+ */
+void
 ev_document_factory_add_filters (GtkWidget *chooser, EvDocument *document)
 {
 	GList         *all_types;
@@ -319,6 +344,9 @@ ev_document_factory_add_filters (GtkWidget *chooser, EvDocument *document)
 	GtkFileFilter *default_filter;
 	GtkFileFilter *document_filter;
 
+        g_return_if_fail (GTK_IS_FILE_CHOOSER (chooser));
+        g_return_if_fail (document == NULL || EV_IS_DOCUMENT (document));
+
 	all_types = ev_backends_manager_get_all_types_info ();
 	
 	default_filter = document_filter = filter = gtk_file_filter_new ();