Update function descriptions in GCPad.cpp and Wiimote.cpp

Add inputs. Those that still need a description are tagged with [Description Needed]
This commit is contained in:
Lioncash 2013-04-01 18:07:44 -04:00
parent 1f9e3b460d
commit 04913a855e
2 changed files with 32 additions and 19 deletions

View File

@ -89,9 +89,11 @@ void GetStatus(u8 _numPAD, SPADStatus* _pPADStatus)
} }
// __________________________________________________________________________________________________ // __________________________________________________________________________________________________
// Function: PAD_Rumble // Function: Rumble
// Purpose: Pad rumble! // Purpose: Pad rumble!
// input: PAD number, Command type (Stop=0, Rumble=1, Stop Hard=2) and strength of Rumble // input: _numPad - Which pad to rumble.
// _uType - Command type (Stop=0, Rumble=1, Stop Hard=2).
// _uStrength - Strength of the Rumble
// output: none // output: none
// //
void Rumble(u8 _numPAD, unsigned int _uType, unsigned int _uStrength) void Rumble(u8 _numPAD, unsigned int _uType, unsigned int _uStrength)
@ -116,8 +118,9 @@ void Rumble(u8 _numPAD, unsigned int _uType, unsigned int _uStrength)
// __________________________________________________________________________________________________ // __________________________________________________________________________________________________
// Function: Motor // Function: Motor
// Purpose: For devices with constant Force feedback // Purpose: For devices with constant Force feedback
// input: Type - 06 = Motor On, 04 = Motor Off // input: _numPAD - The pad to operate on
// Strength - 00 = Left Strong, 127 = Left Weak, 128 = Right Weak, 255 = Right Strong // _uType - 06 = Motor On, 04 = Motor Off
// _uStrength - 00 = Left Strong, 127 = Left Weak, 128 = Right Weak, 255 = Right Strong
// output: none // output: none
// //
void Motor(u8 _numPAD, unsigned int _uType, unsigned int _uStrength) void Motor(u8 _numPAD, unsigned int _uType, unsigned int _uStrength)

View File

@ -55,11 +55,16 @@ void Initialize(void* const hwnd)
} }
// __________________________________________________________________________________________________ // __________________________________________________________________________________________________
// Function: Wiimote_Output // Function: ControlChannel
// Purpose: An L2CAP packet is passed from the Core to the Wiimote, // Purpose: An L2CAP packet is passed from the Core to the Wiimote,
// on the HID CONTROL channel. // on the HID CONTROL channel.
// input: Da pakket. //
// output: none // Inputs: _number [Description needed]
// _channelID [Description needed]
// _pData [Description needed]
// _Size [Description needed]
//
// Output: none
// //
void ControlChannel(int _number, u16 _channelID, const void* _pData, u32 _Size) void ControlChannel(int _number, u16 _channelID, const void* _pData, u32 _Size)
{ {
@ -71,11 +76,16 @@ void ControlChannel(int _number, u16 _channelID, const void* _pData, u32 _Size)
} }
// __________________________________________________________________________________________________ // __________________________________________________________________________________________________
// Function: Wiimote_InterruptChannel // Function: InterruptChannel
// Purpose: An L2CAP packet is passed from the Core to the Wiimote, // Purpose: An L2CAP packet is passed from the Core to the Wiimote,
// on the HID INTERRUPT channel. // on the HID INTERRUPT channel.
// input: Da pakket. //
// output: none // Inputs: _number [Description needed]
// _channelID [Description needed]
// _pData [Description needed]
// _Size [Description needed]
//
// Output: none
// //
void InterruptChannel(int _number, u16 _channelID, const void* _pData, u32 _Size) void InterruptChannel(int _number, u16 _channelID, const void* _pData, u32 _Size)
{ {
@ -86,9 +96,9 @@ void InterruptChannel(int _number, u16 _channelID, const void* _pData, u32 _Size
} }
// __________________________________________________________________________________________________ // __________________________________________________________________________________________________
// Function: Wiimote_Update // Function: Update
// Purpose: This function is called periodically by the Core. // Purpose: This function is called periodically by the Core. // TODO: Explain why.
// input: none // input: _number: [Description needed]
// output: none // output: none
// //
void Update(int _number) void Update(int _number)
@ -113,10 +123,10 @@ void Update(int _number)
} }
// __________________________________________________________________________________________________ // __________________________________________________________________________________________________
// Function: PAD_GetAttachedPads // Function: GetAttached
// Purpose: Get mask of attached pads (eg: controller 1 & 4 -> 0x9) // Purpose: Get mask of attached pads (eg: controller 1 & 4 -> 0x9)
// input: none // input: none
// output: number of pads // output: The number of attached pads
// //
unsigned int GetAttached() unsigned int GetAttached()
{ {
@ -130,8 +140,8 @@ unsigned int GetAttached()
// ___________________________________________________________________________ // ___________________________________________________________________________
// Function: DoState // Function: DoState
// Purpose: Saves/load state // Purpose: Saves/load state
// input/output: ptr // input/output: ptr: [Description Needed]
// input: mode // input: mode [Description needed]
// //
void DoState(u8 **ptr, PointerWrap::Mode mode) void DoState(u8 **ptr, PointerWrap::Mode mode)
{ {
@ -145,7 +155,7 @@ void DoState(u8 **ptr, PointerWrap::Mode mode)
// ___________________________________________________________________________ // ___________________________________________________________________________
// Function: EmuStateChange // Function: EmuStateChange
// Purpose: Notifies the plugin of a change in emulation state // Purpose: Notifies the plugin of a change in emulation state
// input: newState // input: newState - The new state for the Wiimote to change to.
// output: none // output: none
// //
void EmuStateChange(EMUSTATE_CHANGE newState) void EmuStateChange(EMUSTATE_CHANGE newState)