summaryrefslogtreecommitdiff
path: root/public/fpdf_edit.h
diff options
context:
space:
mode:
authorweili <weili@chromium.org>2016-08-19 16:19:46 -0700
committerCommit bot <commit-bot@chromium.org>2016-08-19 16:19:46 -0700
commit9b777deb00fb50dba37ccc1ee69767c6e04a3ee4 (patch)
tree5563d0ad14fab5decc89be923c1d9cc330cb20d1 /public/fpdf_edit.h
parent19ecc23e30f0d5368a703d751afd718a0c6434f6 (diff)
downloadpdfium-9b777deb00fb50dba37ccc1ee69767c6e04a3ee4.tar.xz
Fix an embedder test with leaked page objectchromium/2836chromium/2835
The public API FPDFPage_New() incorrectly said to use FPDFPage_Delete() instead of FPDF_ClosePage() to free the new page. This led to a page object leak in an embedder test. Correct the public API description as well as its usage in the embedder test. BUG=pdfium:242 Review-Url: https://codereview.chromium.org/2260683003
Diffstat (limited to 'public/fpdf_edit.h')
-rw-r--r--public/fpdf_edit.h7
1 files changed, 5 insertions, 2 deletions
diff --git a/public/fpdf_edit.h b/public/fpdf_edit.h
index acec6c0d30..47fdf9e76e 100644
--- a/public/fpdf_edit.h
+++ b/public/fpdf_edit.h
@@ -38,13 +38,16 @@ DLLEXPORT FPDF_DOCUMENT STDCALL FPDF_CreateNewDocument();
// Create a new PDF page.
//
// document - handle to document.
-// page_index - the index of the page to create.
+// 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.
//
// Returns the handle to the new page.
//
-// The page should be deleted with |FPDFPage_Delete| when finished.
+// The page should be closed with CPDF_ClosePage() when finished as
+// with any other page in the document.
DLLEXPORT FPDF_PAGE STDCALL FPDFPage_New(FPDF_DOCUMENT document,
int page_index,
double width,