Eliminate some title case, and improve wording and typos

This commit is contained in:
Derek "Turtle" Roe 2021-03-11 02:02:21 -06:00
parent f4032a4e64
commit 74c1389e75
1 changed files with 11 additions and 11 deletions

View File

@ -4,11 +4,11 @@
extern "C" { extern "C" {
#endif #endif
// Get Plugin Settings, take a setting id // Get plugin settings, take a setting ID
unsigned int GetSetting(short SettingID); unsigned int GetSetting(short SettingID);
const char * GetSettingSz(short SettingID, char * Buffer, int BufferLen); const char * GetSettingSz(short SettingID, char * Buffer, int BufferLen);
// Get System Settings, take a setting returned by FindSystemSettingId // Get system settings, take a setting returned by FindSystemSettingId
unsigned int GetSystemSetting(short SettingID); unsigned int GetSystemSetting(short SettingID);
const char * GetSystemSettingSz(short SettingID, char * Buffer, int BufferLen); const char * GetSystemSettingSz(short SettingID, char * Buffer, int BufferLen);
@ -19,20 +19,20 @@ extern "C" {
void SetSystemSetting(short SettingID, unsigned int Value); void SetSystemSetting(short SettingID, unsigned int Value);
void SetSystemSettingSz(short SettingID, const char * Value); void SetSystemSettingSz(short SettingID, const char * Value);
// enum's // Enums
enum SETTING_DATA_TYPE enum SETTING_DATA_TYPE
{ {
Data_DWORD_General = 0, // A unsigned int setting used anywhere Data_DWORD_General = 0, // An unsigned int setting used anywhere
Data_String_General = 1, // A string setting used anywhere Data_String_General = 1, // A string setting used anywhere
Data_DWORD_Game = 2, // A unsigned int associated with the current game Data_DWORD_Game = 2, // An unsigned int associated with the current game
Data_String_Game = 3, // A string associated with the current game Data_String_Game = 3, // A string associated with the current game
Data_DWORD_RDB = 4, // A unsigned int associated with the current game in the rom database Data_DWORD_RDB = 4, // An unsigned int associated with the current game in the ROM database
Data_String_RDB = 5, // A string associated with the current game in the rom database Data_String_RDB = 5, // A string associated with the current game in the ROM database
Data_DWORD_RDB_Setting = 6, // A unsigned int read from the rom database, with config file Data_DWORD_RDB_Setting = 6, // An unsigned int read from the ROM database, with config file
Data_String_RDB_Setting = 7, // A string read from the rom database, with config file Data_String_RDB_Setting = 7, // A string read from the ROM database, with config file
}; };
// set other information about different settings // Set other information about various settings
int SettingsInitilized(void); int SettingsInitilized(void);
void SetModuleName(const char * Name); void SetModuleName(const char * Name);
void RegisterSetting(short SettingID, SETTING_DATA_TYPE Type, const char * Name, const char * Category, void RegisterSetting(short SettingID, SETTING_DATA_TYPE Type, const char * Name, const char * Category,
@ -41,7 +41,7 @@ extern "C" {
short FindSystemSettingId(const char * Name); short FindSystemSettingId(const char * Name);
void FlushSettings(void); void FlushSettings(void);
// this must be implemented to be notified when a setting is used but has not been set up // This must be implemented to be notified when a setting is used but has not been set up
void UseUnregisteredSetting(int SettingID); void UseUnregisteredSetting(int SettingID);
typedef void(*SettingChangedFunc)(void *); typedef void(*SettingChangedFunc)(void *);