Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(817)

Unified Diff: public/fpdf_flatten.h

Issue 1917103002: Continue documentation cleanup (Closed) Base URL: https://pdfium.googlesource.com/pdfium.git@master
Patch Set: Created 4 years, 8 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « public/fpdf_ext.h ('k') | public/fpdf_fwlevent.h » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: public/fpdf_flatten.h
diff --git a/public/fpdf_flatten.h b/public/fpdf_flatten.h
index af77c29343247b6712228fb73409a3d5e61d21b2..8d641809fe89c44ccadaf70636646a8dab95c5e5 100644
--- a/public/fpdf_flatten.h
+++ b/public/fpdf_flatten.h
@@ -9,37 +9,35 @@
#include "fpdfview.h"
-// Result codes.
-#define FLATTEN_FAIL 0 // Flatten operation failed.
-#define FLATTEN_SUCCESS 1 // Flatten operation succeed.
-#define FLATTEN_NOTHINGTODO 2 // There is nothing to be flattened.
-
-// Flags.
+// Flatten operation failed.
+#define FLATTEN_FAIL 0
+// Flatten operation succeed.
+#define FLATTEN_SUCCESS 1
+// Nothing to be flattened.
+#define FLATTEN_NOTHINGTODO 2
+
+// Flatten for normal display.
#define FLAT_NORMALDISPLAY 0
+// Flatten for print.
#define FLAT_PRINT 1
#ifdef __cplusplus
extern "C" {
-#endif
-
-// Function: FPDFPage_Flatten
-// Make annotations and form fields become part of the page contents
-// itself.
-// Parameters:
-// page - Handle to the page, as returned by FPDF_LoadPage().
-// nFlag - Intended use of the flattened result: 0 for normal display,
-// 1 for printing.
-// Return value:
-// Either FLATTEN_FAIL, FLATTEN_SUCCESS, or FLATTEN_NOTHINGTODO (see
-// above).
-// Comments:
-// Currently, all failures return FLATTEN_FAIL, with no indication for
-// the reason
-// for the failure.
+#endif // __cplusplus
+
+// Flatten annotations and form fields into the page contents.
+//
+// page - handle to the page.
+// nFlag - One of the |FLAT_*| values denoting the page usage.
+//
+// Returns one of the |FLATTEN_*| values.
+//
+// Currently, all failures return |FLATTEN_FAIL| with no indication of the
+// cause.
DLLEXPORT int STDCALL FPDFPage_Flatten(FPDF_PAGE page, int nFlag);
#ifdef __cplusplus
-}
-#endif
+} // extern "C"
+#endif // __cplusplus
#endif // PUBLIC_FPDF_FLATTEN_H_
« no previous file with comments | « public/fpdf_ext.h ('k') | public/fpdf_fwlevent.h » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698