Merge pull request #1869 from Stevoisiak/GeneralConsistency

Minor consistency changes

Source/Core/AudioCommon/OpenALStream.cpp

@@ -132,7 +132,7 @@ void OpenALStream::SoundLoop()
 #if defined(__APPLE__)
 	bool float32_capable = false;
 	const ALenum AL_FORMAT_STEREO_FLOAT32 = 0;
-	// OSX does not have the alext AL_FORMAT_51CHN32 yet.
+	// OS X does not have the alext AL_FORMAT_51CHN32 yet.
 	surround_capable = false;
 	const ALenum AL_FORMAT_51CHN32 = 0;
 #else

Source/Core/Common/ArmCPUDetect.cpp

@@ -149,11 +149,11 @@ CPUInfo::CPUInfo()
 	Detect();
 }
 
-// Detects the various cpu features
+// Detects the various CPU features
 void CPUInfo::Detect()
 {
 	// Set some defaults here
-	// When ARMv8 cpus come out, these need to be updated.
+	// When ARMv8 CPUs come out, these need to be updated.
 	HTT = false;
 #ifdef _M_ARM_64
 	OS64bit = true;
@@ -251,7 +251,7 @@ void CPUInfo::Detect()
 #endif
 }
 
-// Turn the cpu info into a string we can show
+// Turn the CPU info into a string we can show
 std::string CPUInfo::Summarize()
 {
 	std::string sum;

Source/Core/Common/ArmEmitter.h

@@ -390,7 +390,7 @@ public:
 	void MCR(u32 coproc, u32 opc1, ARMReg Rt, u32 CRn, u32 CRm, u32 opc2 = 0);
 
 	// Do nothing
-	void NOP(int count = 1); //nop padding - TODO: fast nop slides, for amd and intel (check their manuals)
+	void NOP(int count = 1); //nop padding - TODO: fast nop slides, for AMD and Intel (check their manuals)
 
 #ifdef CALL
 #undef CALL
@@ -476,7 +476,7 @@ public:
 	void UBFX(ARMReg dest, ARMReg op2, u8 lsb, u8 width);
 	void CLZ(ARMReg rd, ARMReg rm);
 
-	// Using just MSR here messes with our defines on the PPC side of stuff (when this code was in dolphin...)
+	// Using just MSR here messes with our defines on the PPC side of stuff (when this code was in Dolphin...)
 	// Just need to put an underscore here, bit annoying.
 	void _MSR (bool nzcvq, bool g, Operand2 op2);
 	void _MSR (bool nzcvq, bool g, ARMReg src);

Source/Core/Common/Common.h

@@ -81,7 +81,7 @@ private:
 	#define GC_ALIGNED16_DECL(x) __declspec(align(16)) x
 	#define GC_ALIGNED64_DECL(x) __declspec(align(64)) x
 
-// Since they are always around on windows
+// Since they are always around on Windows
 	#define HAVE_WX 1
 	#define HAVE_OPENAL 1
 

Source/Core/Common/CommonFuncs.h

@@ -108,7 +108,7 @@ inline u64 _rotr64(u64 x, unsigned int shift)
 	#define snprintf _snprintf
 	#define vscprintf _vscprintf
 
-// 64 bit offsets for windows
+// 64 bit offsets for Windows
 	#define fseeko _fseeki64
 	#define ftello _ftelli64
 	#define atoll _atoi64

Source/Core/Common/CommonPaths.h

@@ -31,7 +31,7 @@
 	#endif
 #endif
 
-// Shared data dirs (Sys and shared User for linux)
+// Shared data dirs (Sys and shared User for Linux)
 #ifdef _WIN32
 	#define SYSDATA_DIR "Sys"
 #elif defined __APPLE__

Source/Core/Common/CommonTypes.h

@@ -40,7 +40,7 @@ typedef int32_t s32;
 typedef int64_t s64;
 
 #endif
-// For using windows lock code
+// For using Windows lock code
 #define TCHAR char
 #define LONG int
 

Source/Core/Common/FileUtil.cpp

@@ -469,7 +469,7 @@ u32 ScanDirectoryTree(const std::string &directory, FSTEntry& parentEntry)
 		FindClose(hFind);
 		return foundEntries;
 	}
-	// windows loop
+	// Windows loop
 	do
 	{
 		FSTEntry entry;
@@ -481,7 +481,7 @@ u32 ScanDirectoryTree(const std::string &directory, FSTEntry& parentEntry)
 	if (!dirp)
 		return 0;
 
-	// non windows loop
+	// non Windows loop
 	while (!readdir_r(dirp, &dirent, &result) && result)
 	{
 		FSTEntry entry;
@@ -538,7 +538,7 @@ bool DeleteDirRecursively(const std::string &directory)
 		return false;
 	}
 
-	// windows loop
+	// Windows loop
 	do
 	{
 		const std::string virtualName(TStrToUTF8(ffd.cFileName));
@@ -548,7 +548,7 @@ bool DeleteDirRecursively(const std::string &directory)
 	if (!dirp)
 		return false;
 
-	// non windows loop
+	// non Windows loop
 	while (!readdir_r(dirp, &dirent, &result) && result)
 	{
 		const std::string virtualName = result->d_name;

Source/Core/Common/StringUtil.cpp

@@ -218,7 +218,7 @@ bool SplitPath(const std::string& full_path, std::string* _pPath, std::string* _
 		return false;
 
 	size_t dir_end = full_path.find_last_of("/"
-	// windows needs the : included for something like just "C:" to be considered a directory
+	// Windows needs the : included for something like just "C:" to be considered a directory
 #ifdef _WIN32
 		":"
 #endif

Source/Core/Common/Thread.h

@@ -32,7 +32,7 @@ int CurrentThreadId();
 void SetThreadAffinity(std::thread::native_handle_type thread, u32 mask);
 void SetCurrentThreadAffinity(u32 mask);
 
-// TODO: doesn't work on windows with (count > 2)
+// TODO: doesn't work on Windows with (count > 2)
 class Barrier
 {
 public:

Source/Core/Common/x64Emitter.cpp

@@ -374,7 +374,7 @@ void XEmitter::JMPptr(const OpArg &arg2)
 }
 
 //Can be used to trap other processors, before overwriting their code
-// not used in dolphin
+// not used in Dolphin
 void XEmitter::JMPself()
 {
 	Write8(0xEB);
@@ -968,8 +968,8 @@ void XEmitter::WriteShift(int bits, OpArg dest, OpArg &shift, int ext)
 		Write8((u8)shift.offset);
 }
 
-// large rotates and shift are slower on intel than amd
-// intel likes to rotate by 1, and the op is smaller too
+// large rotates and shift are slower on Intel than AMD
+// Intel likes to rotate by 1, and the op is smaller too
 void XEmitter::ROL(int bits, OpArg dest, OpArg shift) {WriteShift(bits, dest, shift, 0);}
 void XEmitter::ROR(int bits, OpArg dest, OpArg shift) {WriteShift(bits, dest, shift, 1);}
 void XEmitter::RCL(int bits, OpArg dest, OpArg shift) {WriteShift(bits, dest, shift, 2);}

Source/Core/Core/ARDecrypt.cpp

@@ -375,7 +375,7 @@ static bool batchdecrypt(u32 *codes, u16 size)
 	getbitstring(tmparray,tmparray2+5,2);  // Region
 
 	// Grab gameid and region from the last decrypted code
-	// TODO: Maybe check this against dolphin's GameID? - "code is for wrong game" type msg
+	// TODO: Maybe check this against Dolphin's GameID? - "code is for wrong game" type msg
 	//gameid = tmparray2[1];
 	//region = tmparray2[5];
 

Source/Core/Core/ActionReplay.cpp

@@ -901,7 +901,7 @@ bool RunCode(const ARCode &arcode)
 
 			default:
 				LogInfo("ZCode: Unknown");
-				PanicAlertT("Zero code unknown to dolphin: %08x", zcode);
+				PanicAlertT("Zero code unknown to Dolphin: %08x", zcode);
 				return false;
 				break;
 			}

Source/Core/Core/Core.cpp

@@ -374,7 +374,7 @@ void EmuThread()
 	{
 		Wiimote::Initialize(s_window_handle, !s_state_filename.empty());
 
-		// Activate wiimotes which don't have source set to "None"
+		// Activate Wiimotes which don't have source set to "None"
 		for (unsigned int i = 0; i != MAX_BBMOTES; ++i)
 			if (g_wiimote_sources[i])
 				GetUsbPointer()->AccessWiiMote(i | 0x100)->Activate(true);
@@ -440,7 +440,7 @@ void EmuThread()
 		// The EmuThread is thus an idle thread, which sleeps while
 		// waiting for the program to terminate. Without this extra
 		// thread, the video backend window hangs in single core mode
-		// because noone is pumping messages.
+		// because no one is pumping messages.
 		Common::SetCurrentThreadName("Emuthread - Idle");
 
 		// Spawn the CPU+GPU thread

Source/Core/Core/DSP/DSPAccelerator.cpp

@@ -44,7 +44,7 @@ static s16 ADPCM_Step(u32& _rSamplePos)
 
 	_rSamplePos++;
 
-	// The advanced interpolation (linear, polyphase,...) is done by the UCode,
+	// The advanced interpolation (linear, polyphase,...) is done by the ucode,
 	// so we don't need to bother with it here.
 	return val;
 }
@@ -87,7 +87,7 @@ void dsp_write_aram_d3(u16 value)
 	// Zelda ucode writes a bunch of zeros to ARAM through d3 during
 	// initialization.  Don't know if it ever does it later, too.
 	// Pikmin 2 Wii writes non-stop to 0x10008000-0x1000801f (non-zero values too)
-	// Zelda TP WII writes non-stop to 0x10000000-0x1000001f (non-zero values too)
+	// Zelda TP Wii writes non-stop to 0x10000000-0x1000001f (non-zero values too)
 	u32 Address = (g_dsp.ifx_regs[DSP_ACCAH] << 16) | g_dsp.ifx_regs[DSP_ACCAL];
 
 	switch (g_dsp.ifx_regs[DSP_FORMAT])
@@ -116,7 +116,7 @@ u16 dsp_read_accelerator()
 	// let's do the "hardware" decode DSP_FORMAT is interesting - the Zelda
 	// ucode seems to indicate that the bottom two bits specify the "read size"
 	// and the address multiplier.  The bits above that may be things like sign
-	// extention and do/do not use ADPCM.  It also remains to be figured out
+	// extension and do/do not use ADPCM.  It also remains to be figured out
 	// whether there's a difference between the usual accelerator "read
 	// address" and 0xd3.
 	switch (g_dsp.ifx_regs[DSP_FORMAT])
@@ -152,7 +152,7 @@ u16 dsp_read_accelerator()
 
 	// TODO: Take GAIN into account
 	// adpcm = 0, pcm8 = 0x100, pcm16 = 0x800
-	// games using pcm8 : Phoenix Wright Ace Attorney (Wiiware), Megaman 9-10 (WiiWare)
+	// games using pcm8 : Phoenix Wright Ace Attorney (WiiWare), Megaman 9-10 (WiiWare)
 	// games using pcm16: GC Sega games, ...
 
 	// Check for loop.

Source/Core/Core/DSP/DSPIntExtOps.cpp

@@ -34,7 +34,7 @@ namespace Ext
 
 inline bool IsSameMemArea(u16 a, u16 b)
 {
-	//LM: tested on WII
+	// LM: tested on Wii
 	if ((a>>10)==(b>>10))
 		return true;
 	else
@@ -532,7 +532,7 @@ void applyWriteBackLog()
 // then 0 | ext output = ext output and if it did then bitwise or is still the
 // right thing to do
 // Only needed for cases when mainop and extended are modifying the same ACC
-// Games are not doing that + in motorola (similar dsp) dox this is forbidden to do.
+// Games are not doing that + in motorola (similar DSP) dox this is forbidden to do.
 void zeroWriteBackLog()
 {
 #ifdef PRECISE_BACKLOG

Source/Core/Core/DSP/DSPInterpreter.cpp

@@ -48,7 +48,7 @@ void WriteCR(u16 val)
 	else if (val == 4)
 	{
 		// HAX!
-		// OSInitAudioSystem ucode should send this mail - not dsp core itself
+		// OSInitAudioSystem ucode should send this mail - not DSP core itself
 		INFO_LOG(DSPLLE,"DSP_CONTROL INIT");
 		init_hax = true;
 		val |= 0x800;

Source/Core/Core/DSP/Jit/DSPJitUtil.cpp

@@ -509,7 +509,7 @@ void DSPEmitter::decrease_addr_reg(int reg)
 
 
 // EAX - destination address
-// ECX - Base of dram
+// ECX - Base of DRAM
 void DSPEmitter::dmem_write(X64Reg value)
 {
 	//	if (saddr == 0)

Source/Core/Core/HLE/HLE_OS.cpp

@@ -121,7 +121,7 @@ void GetStringVA(std::string& _rOutBuffer, u32 strReg)
 			}
 
 			case 'p':
-				// Override, so 64bit dolphin prints 32bit pointers, since the ppc is 32bit :)
+				// Override, so 64bit Dolphin prints 32bit pointers, since the ppc is 32bit :)
 				_rOutBuffer += StringFromFormat("%x", (u32)Parameter);
 				break;
 

Source/Core/Core/HW/DSP.cpp

@@ -184,7 +184,7 @@ static DSPEmulator *dsp_emulator;
 static int dsp_slice = 0;
 static bool dsp_is_lle = false;
 
-//time given to lle dsp on every read of the high bits in a mailbox
+// time given to LLE DSP on every read of the high bits in a mailbox
 static const int DSP_MAIL_SLICE=72;
 
 void DoState(PointerWrap &p)
@@ -245,7 +245,7 @@ void Init(bool hle)
 	}
 	else
 	{
-		// On the GC, ARAM is accessible only through this interface.
+		// On the GameCube, ARAM is accessible only through this interface.
 		g_ARAM.wii_mode = false;
 		g_ARAM.size = ARAM_SIZE;
 		g_ARAM.mask = ARAM_MASK;
@@ -366,7 +366,7 @@ void RegisterMMIO(MMIO::Mapping* mmio, u32 base)
 
 			// Not really sure if this is correct, but it works...
 			// Kind of a hack because DSP_CONTROL_MASK should make this bit
-			// only viewable to dsp emulator
+			// only viewable to DSP emulator
 			if (val & 1 /*DSPReset*/)
 			{
 				g_audioDMA.AudioDMAControl.Hex = 0;
@@ -480,15 +480,15 @@ void GenerateDSPInterruptFromDSPEmu(DSPInterruptType type)
 	CoreTiming::ScheduleEvent_Threadsafe_Immediate(et_GenerateDSPInterrupt, type);
 }
 
-// called whenever SystemTimers thinks the dsp deserves a few more cycles
+// called whenever SystemTimers thinks the DSP deserves a few more cycles
 void UpdateDSPSlice(int cycles)
 {
 	if (dsp_is_lle)
 	{
-		//use up the rest of the slice(if any)
+		// use up the rest of the slice(if any)
 		dsp_emulator->DSP_Update(dsp_slice);
 		dsp_slice %= 6;
-		//note the new budget
+		// note the new budget
 		dsp_slice += cycles;
 	}
 	else
@@ -588,7 +588,7 @@ static void Do_ARAM_DMA()
 		}
 		else
 		{
-			// Assuming no external ARAM installed; returns zeroes on out of bounds reads (verified on real HW)
+			// Assuming no external ARAM installed; returns zeros on out of bounds reads (verified on real HW)
 			while (g_arDMA.Cnt.count)
 			{
 				Memory::Write_U64(0, g_arDMA.MMAddr);
@@ -646,7 +646,7 @@ static void Do_ARAM_DMA()
 
 // (shuffle2) I still don't believe that this hack is actually needed... :(
 // Maybe the Wii Sports ucode is processed incorrectly?
-// (LM) It just means that dsp reads via '0xffdd' on WII can end up in EXRAM or main RAM
+// (LM) It just means that DSP reads via '0xffdd' on Wii can end up in EXRAM or main RAM
 u8 ReadARAM(u32 _iAddress)
 {
 	//NOTICE_LOG(DSPINTERFACE, "ReadARAM 0x%08x", _iAddress);
@@ -665,8 +665,8 @@ u8 ReadARAM(u32 _iAddress)
 
 void WriteARAM(u8 value, u32 _uAddress)
 {
-	//NOTICE_LOG(DSPINTERFACE, "WriteARAM 0x%08x", _uAddress);
-	//TODO: verify this on WII
+	// NOTICE_LOG(DSPINTERFACE, "WriteARAM 0x%08x", _uAddress);
+	// TODO: verify this on Wii
 	g_ARAM.ptr[_uAddress & g_ARAM.mask] = value;
 }