summaryrefslogtreecommitdiff
path: root/public/fpdf_edit.h
diff options
context:
space:
mode:
authorLei Zhang <thestig@chromium.org>2018-01-31 14:53:02 +0000
committerChromium commit bot <commit-bot@chromium.org>2018-01-31 14:53:02 +0000
commit3f3f5130e91c9a868831ee80840f027111ee6f3b (patch)
treedb8df0df06bf09d48efe1400e336f1d1e4e1078d /public/fpdf_edit.h
parent4b0c5b935471897e12a21c680aff0ba17d0686e8 (diff)
downloadpdfium-3f3f5130e91c9a868831ee80840f027111ee6f3b.tar.xz
Clean up FPDFPage_New() documentation.
Change-Id: I3ee754c2875b6ea28750803dbd8e4d9fe6dd1d41 Reviewed-on: https://pdfium-review.googlesource.com/24570 Commit-Queue: dsinclair <dsinclair@chromium.org> Reviewed-by: dsinclair <dsinclair@chromium.org>
Diffstat (limited to 'public/fpdf_edit.h')
-rw-r--r--public/fpdf_edit.h14
1 files changed, 7 insertions, 7 deletions
diff --git a/public/fpdf_edit.h b/public/fpdf_edit.h
index 685fbdd029..54735a3bde 100644
--- a/public/fpdf_edit.h
+++ b/public/fpdf_edit.h
@@ -97,15 +97,15 @@ FPDF_EXPORT FPDF_DOCUMENT FPDF_CALLCONV FPDF_CreateNewDocument();
// Create a new PDF page.
//
// document - handle to document.
-// page_index - suggested index of the page to create. If it is larger than
-// document's current last index(L), the created page index is
-// the next available index -- L+1.
-// width - the page width.
-// height - the page height.
+// page_index - suggested 0-based index of the page to create. If it is larger
+// than document's current last index(L), the created page index
+// is the next available index -- L+1.
+// width - the page width in points.
+// height - the page height in points.
//
-// Returns the handle to the new page.
+// Returns the handle to the new page or NULL on failure.
//
-// The page should be closed with CPDF_ClosePage() when finished as
+// The page should be closed with FPDF_ClosePage() when finished as
// with any other page in the document.
FPDF_EXPORT FPDF_PAGE FPDF_CALLCONV FPDFPage_New(FPDF_DOCUMENT document,
int page_index,