From 860193b775f19a176963e31d41f641455499fccb Mon Sep 17 00:00:00 2001
From: dsinclair <dsinclair@chromium.org>
Date: Mon, 25 Apr 2016 19:44:20 -0700
Subject: Continue documentation cleanup

Reformat some more public/ header documentation.

Review URL: https://codereview.chromium.org/1917103002
---
 public/fpdf_flatten.h | 46 ++++++++++++++++++++++------------------------
 1 file changed, 22 insertions(+), 24 deletions(-)

(limited to 'public/fpdf_flatten.h')

diff --git a/public/fpdf_flatten.h b/public/fpdf_flatten.h
index af77c29343..8d641809fe 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_
-- 
cgit v1.2.3