summaryrefslogtreecommitdiff
path: root/public/fpdf_fwlevent.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_fwlevent.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_fwlevent.h')
-rw-r--r--public/fpdf_fwlevent.h27
1 files changed, 14 insertions, 13 deletions
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_