Update Controller_1.1.h

Change multi-line comments into single line comments, fix some typos, remove some title case, improve grammar, update some things for consistency, fix abbreviations

Source/Android/PluginInput/Controller_1.1.h

@@ -1,13 +1,13 @@
-/**********************************************************************************
+// Common controller plugin specification, version 1.1
-Common Controller plugin spec, version #1.1
+
-**********************************************************************************/
 #pragma once
 
 #include <Common/stdtypes.h>
 
 enum { PLUGIN_TYPE_CONTROLLER = 4 };
 
-/*** Conteroller plugin's ****/
+// Controller plugins
+
 enum
 {
     PLUGIN_NONE = 1,
@@ -25,12 +25,13 @@ enum
 #define CALL
 #endif
 
-/***** Structures *****/
+// Structures
+
 typedef struct
 {
-    uint16_t Version;        /* Should be set to 0x0101 */
+    uint16_t Version;        // Should be set to 0x0101
-    uint16_t Type;           /* Set to PLUGIN_TYPE_CONTROLLER */
+    uint16_t Type;           // Set to PLUGIN_TYPE_CONTROLLER
-    char Name[100];          /* Name of the DLL */
+    char Name[100];          // Name of the DLL
     int32_t Reserved1;
     int32_t Reserved2;
 } PLUGIN_INFO;
@@ -80,26 +81,27 @@ typedef struct
     void * hMainWindow;
     void * hinst;
 
-    int32_t MemoryBswaped;  // memory in client- or server-native endian
+    int32_t MemoryBswaped;  // Memory in client or server-native endian
-    uint8_t * HEADER;   // the ROM header (first 40h bytes of the ROM)
+    uint8_t * HEADER;   // The ROM header (first 40h bytes of the ROM)
-    CONTROL * Controls; // pointer to array of 4 controllers, i.e.:  CONTROL Controls[4];
+    CONTROL * Controls; // Pointer to array of 4 controllers, i.e.:  CONTROL Controls[4];
 } CONTROL_INFO;
 
-/******************************************************************
+/*
 Function: CloseDLL
 Purpose:  This function is called when the emulator is closing
-down allowing the dll to de-initialise.
+down allowing the DLL to de-initialize.
 input:    none
 output:   none
-*******************************************************************/
+*/
+
 EXPORT void CALL CloseDLL(void);
 
-/******************************************************************
+/*
 Function: ControllerCommand
 Purpose:  To process the raw data that has just been sent to a
 specific controller.
-input:    - Controller Number (0 to 3) and -1 signalling end of
+input:    - Controller Number (0 to 3) and -1 signaling end of
-processing the pif ram.
+processing the PIF RAM.
 - Pointer of data to be processed.
 output:   none
 
@@ -107,113 +109,125 @@ note:     This function is only needed if the DLL is allowing raw
 data, or the plugin is set to raw
 
 the data that is being processed looks like this:
-initilize controller: 01 03 00 FF FF FF
+initialize controller: 01 03 00 FF FF FF
 read controller:      01 04 01 FF FF FF FF
-*******************************************************************/
+*/
+
 EXPORT void CALL ControllerCommand(int Control, uint8_t * Command);
 
-/******************************************************************
+/*
 Function: DllAbout
 Purpose:  This function is optional function that is provided
 to give further information about the DLL.
 input:    a handle to the window that calls this function
 output:   none
-*******************************************************************/
+*/
+
 EXPORT void CALL DllAbout(void * hParent);
 
-/******************************************************************
+/*
 Function: DllConfig
 Purpose:  This function is optional function that is provided
-to allow the user to configure the dll
+to allow the user to configure the DLL
 input:    a handle to the window that calls this function
 output:   none
-*******************************************************************/
+*/
+
 EXPORT void CALL DllConfig(void * hParent);
 
-/******************************************************************
+/*
 Function: DllTest
 Purpose:  This function is optional function that is provided
-to allow the user to test the dll
+to allow the user to test the DLL
 input:    a handle to the window that calls this function
 output:   none
-*******************************************************************/
+*/
+
 EXPORT void CALL DllTest(void * hParent);
 
-/******************************************************************
+/*
 Function: GetDllInfo
 Purpose:  This function allows the emulator to gather information
-about the dll by filling in the PluginInfo structure.
+about the DLL by filling in the PluginInfo structure.
-input:    a pointer to a PLUGIN_INFO stucture that needs to be
+input:    a pointer to a PLUGIN_INFO structure that needs to be
 filled by the function. (see def above)
 output:   none
-*******************************************************************/
+*/
+
 EXPORT void CALL GetDllInfo(PLUGIN_INFO * PluginInfo);
 
-/******************************************************************
+/*
 Function: GetKeys
 Purpose:  To get the current state of the controllers buttons.
 input:    - Controller Number (0 to 3)
 - A pointer to a BUTTONS structure to be filled with
 the controller state.
 output:   none
-*******************************************************************/
+*/
+
 EXPORT void CALL GetKeys(int32_t Control, BUTTONS * Keys);
 
-/******************************************************************
+/*
 Function: InitiateControllers
-Purpose:  This function initialises how each of the controllers
+Purpose:  This function initializes how each of the controllers
 should be handled.
 input:    - The handle to the main window.
 - A controller structure that needs to be filled for
 the emulator to know how to handle each controller.
 output:   none
-*******************************************************************/
+*/
+
 EXPORT void CALL InitiateControllers(CONTROL_INFO ControlInfo);
 
-/******************************************************************
+/*
 Function: ReadController
-Purpose:  To process the raw data in the pif ram that is about to
+Purpose:  To process the raw data in the PIF RAM that is about to
 be read.
-input:    - Controller Number (0 to 3) and -1 signalling end of
+input:    - Controller Number (0 to 3) and -1 signaling end of
-processing the pif ram.
+processing the PIF RAM.
 - Pointer of data to be processed.
 output:   none
 note:     This function is only needed if the DLL is allowing raw
 data.
-*******************************************************************/
+*/
+
 EXPORT void CALL ReadController(int Control, uint8_t * Command);
 
-/******************************************************************
+/*
 Function: RomClosed
-Purpose:  This function is called when a rom is closed.
+Purpose:  This function is called when a ROM is closed.
 input:    none
 output:   none
-*******************************************************************/
+*/
+
 EXPORT void CALL RomClosed(void);
 
-/******************************************************************
+/*
 Function: RomOpen
-Purpose:  This function is called when a rom is open. (from the
+Purpose:  This function is called when a ROM is open. (from the
 emulation thread)
 input:    none
 output:   none
-*******************************************************************/
+*/
+
 EXPORT void CALL RomOpen(void);
 
-/******************************************************************
+/*
 Function: WM_KeyDown
 Purpose:  To pass the WM_KeyDown message from the emulator to the
 plugin.
 input:    wParam and lParam of the WM_KEYDOWN message.
 output:   none
-*******************************************************************/
+*/
+
 EXPORT void CALL WM_KeyDown(uint32_t wParam, uint32_t lParam);
 
-/******************************************************************
+/*
 Function: WM_KeyUp
 Purpose:  To pass the WM_KEYUP message from the emulator to the
 plugin.
 input:    wParam and lParam of the WM_KEYDOWN message.
 output:   none
-*******************************************************************/
+*/
+
 EXPORT void CALL WM_KeyUp(uint32_t wParam, uint32_t lParam);