[libgxps] doc: Document return value of gxps_document_get_page()

[Carlos Garcia Campos <carlosgc src gnome org>]

commit 93ef0e3a204f097af4e4b1a3623f1ad4ad9a999e
Author: Carlos Garcia Campos <carlosgc gnome org>
Date:   Tue Nov 1 09:59:19 2011 +0100

    doc: Document return value of gxps_document_get_page()

 libgxps/gxps-document.c |    8 ++++++--
 1 files changed, 6 insertions(+), 2 deletions(-)
---
diff --git a/libgxps/gxps-document.c b/libgxps/gxps-document.c
index 5a2f79a..c37b5d5 100644
--- a/libgxps/gxps-document.c
+++ b/libgxps/gxps-document.c
@@ -507,8 +507,12 @@ gxps_document_get_page (GXPSDocument *doc,
  *
  * Gets the size of the page at index @n_page in @doc document.
  * This function is useful to get the size of the pages in a document
- * without creating #GXPSPage objects. To get the size of a #GXPSPage
- * you can use gxps_page_get_size() instead.
+ * without creating #GXPSPage objects. However, page sizes are not always
+ * available in @doc, in which case this function returns %FALSE.
+ * To get the size of a #GXPSPage you can use gxps_page_get_size() instead.
+ *
+ * Returns: %TRUE if the page size information is available in @doc,
+ *     %FALSE otherwise.
  */
 gboolean
 gxps_document_get_page_size (GXPSDocument *doc,