[libgxps] docs: Clarify that page sizes returned by document might be different than actual page sizes
- From: Carlos Garcia Campos <carlosgc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libgxps] docs: Clarify that page sizes returned by document might be different than actual page sizes
- Date: Sun, 6 Nov 2011 12:12:35 +0000 (UTC)
commit 189194e95109d92a2248a5a434ee7de4d99aa983
Author: Carlos Garcia Campos <carlosgc gnome org>
Date: Sun Nov 6 13:11:35 2011 +0100
docs: Clarify that page sizes returned by document might be different than actual page sizes
libgxps/gxps-document.c | 13 ++++++++-----
1 files changed, 8 insertions(+), 5 deletions(-)
---
diff --git a/libgxps/gxps-document.c b/libgxps/gxps-document.c
index 6fffb2c..867cdb3 100644
--- a/libgxps/gxps-document.c
+++ b/libgxps/gxps-document.c
@@ -499,11 +499,14 @@ gxps_document_get_page (GXPSDocument *doc,
* @width: (out) (allow-none): return location for the width of @n_page
* @height: (out) (allow-none): return location for the height of @n_page
*
- * 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. 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.
+ * Gets the typical size of the page at index @n_page in @doc document.
+ * This function is useful to get the advisory size of pages in a document
+ * without creating #GXPSPage objects. This page size might be different than
+ * the actual page size so page dimension might need to be updated once the
+ * page is loaded. Advisory page sizes are not always available in @doc,
+ * in which case this function returns %FALSE.
+ * To get the authoritative size of a page you should use gxps_page_get_size()
+ * instead.
*
* Returns: %TRUE if the page size information is available in @doc,
* %FALSE otherwise.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]