Improve FPDF_GetPageWidthF() / FPDF_GetPageHeightF() documentation
Mention changing the page rotation affects their return values.
Change-Id: I2f950ccb629651bc1d876d9b05868facd41dc6f1
Reviewed-on: https://pdfium-review.googlesource.com/c/pdfium/+/131871
Commit-Queue: Tom Sepez <tsepez@chromium.org>
Commit-Queue: Lei Zhang <thestig@chromium.org>
Reviewed-by: Tom Sepez <tsepez@chromium.org>
diff --git a/public/fpdfview.h b/public/fpdfview.h
index 6922da9..d96556b 100644
--- a/public/fpdfview.h
+++ b/public/fpdfview.h
@@ -701,6 +701,8 @@
// Return value:
// Page width (excluding non-displayable area) measured in points.
// One point is 1/72 inch (around 0.3528 mm).
+// Comments:
+// Changing the rotation of |page| affects the return value.
FPDF_EXPORT float FPDF_CALLCONV FPDF_GetPageWidthF(FPDF_PAGE page);
// Function: FPDF_GetPageWidth
@@ -713,6 +715,8 @@
// Note:
// Prefer FPDF_GetPageWidthF() above. This will be deprecated in the
// future.
+// Comments:
+// Changing the rotation of |page| affects the return value.
FPDF_EXPORT double FPDF_CALLCONV FPDF_GetPageWidth(FPDF_PAGE page);
// Experimental API
@@ -723,6 +727,8 @@
// Return value:
// Page height (excluding non-displayable area) measured in points.
// One point is 1/72 inch (around 0.3528 mm)
+// Comments:
+// Changing the rotation of |page| affects the return value.
FPDF_EXPORT float FPDF_CALLCONV FPDF_GetPageHeightF(FPDF_PAGE page);
// Function: FPDF_GetPageHeight
@@ -735,6 +741,8 @@
// Note:
// Prefer FPDF_GetPageHeightF() above. This will be deprecated in the
// future.
+// Comments:
+// Changing the rotation of |page| affects the return value.
FPDF_EXPORT double FPDF_CALLCONV FPDF_GetPageHeight(FPDF_PAGE page);
// Experimental API.
