summaryrefslogtreecommitdiff
path: root/Source/Core
diff options
context:
space:
mode:
authorLioncash <mathew1800@gmail.com>2013-04-01 18:07:44 -0400
committerLioncash <mathew1800@gmail.com>2013-04-01 18:07:44 -0400
commit04913a855ec9ca0b028eb74c92a75e9be1217a65 (patch)
tree0fae59f718bb547813e0dd751676c2ea8c2748f3 /Source/Core
parent1f9e3b460d628791167e05b77f30df31e42da891 (diff)
Update function descriptions in GCPad.cpp and Wiimote.cpp
Add inputs. Those that still need a description are tagged with [Description Needed]
Diffstat (limited to 'Source/Core')
-rw-r--r--Source/Core/Core/Src/HW/GCPad.cpp11
-rw-r--r--Source/Core/Core/Src/HW/Wiimote.cpp40
2 files changed, 32 insertions, 19 deletions
diff --git a/Source/Core/Core/Src/HW/GCPad.cpp b/Source/Core/Core/Src/HW/GCPad.cpp
index c4798b3964..bf0ea2dcbe 100644
--- a/Source/Core/Core/Src/HW/GCPad.cpp
+++ b/Source/Core/Core/Src/HW/GCPad.cpp
@@ -89,9 +89,11 @@ void GetStatus(u8 _numPAD, SPADStatus* _pPADStatus)
}
// __________________________________________________________________________________________________
-// Function: PAD_Rumble
+// Function: 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
//
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
// Purpose: For devices with constant Force feedback
-// input: Type - 06 = Motor On, 04 = Motor Off
-// Strength - 00 = Left Strong, 127 = Left Weak, 128 = Right Weak, 255 = Right Strong
+// input: _numPAD - The pad to operate on
+// _uType - 06 = Motor On, 04 = Motor Off
+// _uStrength - 00 = Left Strong, 127 = Left Weak, 128 = Right Weak, 255 = Right Strong
// output: none
//
void Motor(u8 _numPAD, unsigned int _uType, unsigned int _uStrength)
diff --git a/Source/Core/Core/Src/HW/Wiimote.cpp b/Source/Core/Core/Src/HW/Wiimote.cpp
index e45856f5f5..d1c0797e30 100644
--- a/Source/Core/Core/Src/HW/Wiimote.cpp
+++ b/Source/Core/Core/Src/HW/Wiimote.cpp
@@ -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,
// 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)
{
@@ -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,
// 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)
{
@@ -86,9 +96,9 @@ void InterruptChannel(int _number, u16 _channelID, const void* _pData, u32 _Size
}
// __________________________________________________________________________________________________
-// Function: Wiimote_Update
-// Purpose: This function is called periodically by the Core.
-// input: none
+// Function: Update
+// Purpose: This function is called periodically by the Core. // TODO: Explain why.
+// input: _number: [Description needed]
// output: none
//
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)
-// input: none
-// output: number of pads
+// input: none
+// output: The number of attached pads
//
unsigned int GetAttached()
{
@@ -130,8 +140,8 @@ unsigned int GetAttached()
// ___________________________________________________________________________
// Function: DoState
// Purpose: Saves/load state
-// input/output: ptr
-// input: mode
+// input/output: ptr: [Description Needed]
+// input: mode [Description needed]
//
void DoState(u8 **ptr, PointerWrap::Mode mode)
{
@@ -145,7 +155,7 @@ void DoState(u8 **ptr, PointerWrap::Mode mode)
// ___________________________________________________________________________
// Function: EmuStateChange
// 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
//
void EmuStateChange(EMUSTATE_CHANGE newState)