summaryrefslogtreecommitdiff
path: root/public/fpdf_ppo.h
diff options
context:
space:
mode:
authordsinclair <dsinclair@chromium.org>2016-04-25 19:44:20 -0700
committerCommit bot <commit-bot@chromium.org>2016-04-25 19:44:21 -0700
commit860193b775f19a176963e31d41f641455499fccb (patch)
treeb32745a7447b29daef256bbfbf9651b5e4a1ed11 /public/fpdf_ppo.h
parent1f5f2fff688f4075a62c87a032c9a9070bde89fc (diff)
downloadpdfium-860193b775f19a176963e31d41f641455499fccb.tar.xz
Continue documentation cleanup
Reformat some more public/ header documentation. Review URL: https://codereview.chromium.org/1917103002
Diffstat (limited to 'public/fpdf_ppo.h')
-rw-r--r--public/fpdf_ppo.h38
1 files changed, 17 insertions, 21 deletions
diff --git a/public/fpdf_ppo.h b/public/fpdf_ppo.h
index e7d77678f9..532494e7fa 100644
--- a/public/fpdf_ppo.h
+++ b/public/fpdf_ppo.h
@@ -13,35 +13,31 @@
extern "C" {
#endif
-// Function: FPDF_ImportPages
-// Import some pages to a PDF document.
-// Parameters:
-// dest_doc - The destination document which add the pages.
-// src_doc - A document to be imported.
-// pagerange - A page range string, Such as "1,3,5-7".
-// If this parameter is NULL, it would import all pages
-// in src_doc.
-// index - The page index wanted to insert from.
-// Return value:
-// TRUE for succeed, FALSE for Failed.
+// Import pages to a FPDF_DOCUMENT.
+//
+// dest_doc - The destination document for the pages.
+// src_doc - The document to be imported.
+// pagerange - A page range string, Such as "1,3,5-7". If |pagerange| is NULL,
+// all pages from |src_doc| are imported.
+// index - The page index to insert at.
+//
+// Returns TRUE on success.
DLLEXPORT FPDF_BOOL STDCALL FPDF_ImportPages(FPDF_DOCUMENT dest_doc,
FPDF_DOCUMENT src_doc,
FPDF_BYTESTRING pagerange,
int index);
-// Function: FPDF_CopyViewerPreferences
-// Copy the viewer preferences from one PDF document to another.#endif
-// Parameters:
-// dest_doc - Handle to document to write the viewer preferences
-// to.
-// src_doc - Handle to document with the viewer preferences.
-// Return value:
-// TRUE for success, FALSE for failure.
+// Copy the viewer preferences from |src_doc| into |dest_doc|.
+//
+// dest_doc - Document to write the viewer preferences into.
+// src_doc - Document to read the viewer preferences from.
+//
+// Returns TRUE on success.
DLLEXPORT FPDF_BOOL STDCALL FPDF_CopyViewerPreferences(FPDF_DOCUMENT dest_doc,
FPDF_DOCUMENT src_doc);
#ifdef __cplusplus
-}
-#endif
+} // extern "C"
+#endif // __cplusplus
#endif // PUBLIC_FPDF_PPO_H_