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_fwlevent.h | 27 ++++++++++++++-------------
 1 file changed, 14 insertions(+), 13 deletions(-)

(limited to 'public/fpdf_fwlevent.h')

diff --git a/public/fpdf_fwlevent.h b/public/fpdf_fwlevent.h
index 22c01e4297..511c6a3480 100644
--- a/public/fpdf_fwlevent.h
+++ b/public/fpdf_fwlevent.h
@@ -11,19 +11,20 @@
 
 #ifdef __cplusplus
 extern "C" {
-#endif
+#endif  // __cplusplus
 
 typedef int FPDF_INT32;
 typedef unsigned int FPDF_UINT32;
 typedef float FPDF_FLOAT;
-// event type
+
+// Event types.
 typedef enum {
   FWL_EVENTTYPE_Mouse = 0,
   FWL_EVENTTYPE_MouseWheel,
   FWL_EVENTTYPE_Key,
 } FWL_EVENTTYPE;
 
-// key flag
+// Key flags.
 typedef enum {
   FWL_EVENTFLAG_ShiftKey = 1 << 0,
   FWL_EVENTFLAG_ControlKey = 1 << 1,
@@ -36,7 +37,7 @@ typedef enum {
   FWL_EVENTFLAG_RightButtonDown = 1 << 8,
 } FWL_EVENTFLAG;
 
-// Mouse message command
+// Mouse messages.
 typedef enum {
   FWL_EVENTMOUSECMD_LButtonDown = 1,
   FWL_EVENTMOUSECMD_LButtonUp,
@@ -53,7 +54,7 @@ typedef enum {
   FWL_EVENTMOUSECMD_MouseLeave,
 } FWL_EVENT_MOUSECMD;
 
-// mouse event
+// Mouse events.
 struct FWL_EVENT_MOUSE {
   FPDF_UINT32 command;
   FPDF_DWORD flag;
@@ -61,7 +62,7 @@ struct FWL_EVENT_MOUSE {
   FPDF_FLOAT y;
 };
 
-// mouse wheel
+// Mouse wheel events.
 struct FWL_EVENT_MOUSEWHEEL {
   FPDF_DWORD flag;
   FPDF_FLOAT x;
@@ -70,7 +71,7 @@ struct FWL_EVENT_MOUSEWHEEL {
   FPDF_FLOAT deltaY;
 };
 
-// virtual keycode
+// Virtual keycodes.
 typedef enum {
   FWL_VKEY_Back = 0x08,
   FWL_VKEY_Tab = 0x09,
@@ -242,14 +243,14 @@ typedef enum {
   FWL_VKEY_Unknown = 0,
 } FWL_VKEYCODE;
 
-// key event command
+// Key event commands.
 typedef enum {
   FWL_EVENTKEYCMD_KeyDown = 1,
   FWL_EVENTKEYCMD_KeyUp,
   FWL_EVENTKEYCMD_Char,
 } FWL_EVENTKEYCMD;
 
-// key event
+// Key events.
 struct FWL_EVENT_KEY {
   FPDF_UINT32 command;
   FPDF_DWORD flag;
@@ -261,9 +262,9 @@ struct FWL_EVENT_KEY {
   } code;
 };
 
-// event type
+// Event types.
 struct FWL_EVENT {
-  // structure size.
+  // Structure size.
   FPDF_UINT32 size;
   // FWL_EVENTTYPE.
   FPDF_UINT32 type;
@@ -275,7 +276,7 @@ struct FWL_EVENT {
 };
 
 #ifdef __cplusplus
-}
-#endif
+}  // extern "C"
+#endif  // __cplusplus
 
 #endif  // PUBLIC_FPDF_FWLEVENT_H_
-- 
cgit v1.2.3