commit 51948abf13328b9ebe6574d77dcdf1f99e94f0da
author Lei Zhang <thestig@chromium.org> Tue Oct 09 22:03:30 2018 +0000
committer Chromium commit bot <commit-bot@chromium.org> Tue Oct 09 22:03:30 2018 +0000
tree c958b1debefa26584d85aaab8513a203a9a3acb5
parent b7519ca7638007e6eaf79f095cdf1d4b25c4730b

Add some comments about pointer ownership in fpdf_transformpage.h.

Remove some unused typedefs.

Change-Id: I9cf99b2daae2c6e86f2d6a2e6e96812b67b28f88
Reviewed-on: https://pdfium-review.googlesource.com/c/43790
Reviewed-by: Tom Sepez <tsepez@chromium.org>
Commit-Queue: Lei Zhang <thestig@chromium.org>

public/fpdf_transformpage.h

diff --git a/public/fpdf_transformpage.h b/public/fpdf_transformpage.h
index 1b3abb6..742da49 100644
--- a/public/fpdf_transformpage.h
+++ b/public/fpdf_transformpage.h
@@ -14,9 +14,6 @@
 extern "C" {
 #endif
 
-typedef void* FPDF_PAGEARCSAVER;
-typedef void* FPDF_PAGEARCLOADER;
-
 /**
  * Set "MediaBox" entry to the page dictionary.
  *
@@ -127,6 +124,9 @@
 /**
  * Create a new clip path, with a rectangle inserted.
  *
+ * Caller takes ownership of the returned FPDF_CLIPPATH. It should be freed with
+ * FPDF_DestroyClipPath().
+ *
  * left   - The left of the clip box.
  * bottom - The bottom of the clip box.
  * right  - The right of the clip box.
@@ -140,7 +140,7 @@
 /**
  * Destroy the clip path.
  *
- * clipPath - A handle to the clip path.
+ * clipPath - A handle to the clip path. It will be invalid after this call.
  */
 FPDF_EXPORT void FPDF_CALLCONV FPDF_DestroyClipPath(FPDF_CLIPPATH clipPath);
 
@@ -152,7 +152,7 @@
  * In this way, the page content will be clipped by this clip path.
  *
  * page        - A page handle.
- * clipPath    - A handle to the clip path.
+ * clipPath    - A handle to the clip path. (Does not take ownership.)
  */
 FPDF_EXPORT void FPDF_CALLCONV FPDFPage_InsertClipPath(FPDF_PAGE page,
                                                        FPDF_CLIPPATH clipPath);