Cumulative docs update (#221)

* lights fix

* names

* remove header

* so many names

* format

* more docs

* makefile

4 files changed, 57 insertions, 57 deletions

diff --git a/linker_scripts/us/symbol_addrs.txt b/linker_scripts/us/symbol_addrs.txt
index b629a9f5..2f4d01f7 100644
--- a/linker_scripts/us/symbol_addrs.txt
+++ b/linker_scripts/us/symbol_addrs.txt
@@ -70,7 +70,7 @@ D_display_801613E0 = 0x801613E0;//size:0x18
 D_edata_800CC124 = 0x800CC124;//type:u8
 D_boss_800C9E90 = 0x800C9E90;//size:0x70
 
-D_play_800D3180 = 0x800D3180; // size:0x20
+gLeveLClearStatus = 0x800D3180; // size:0x20
 gRcpSetupDLs = 0x800D31B0; // size:0x18C0
 
 D_edisplay_800CFCA0 = 0x800CFCA0;
diff --git a/linker_scripts/us/symbol_addrs_audio.txt b/linker_scripts/us/symbol_addrs_audio.txt
index bf9f7536..c3f16723 100644
--- a/linker_scripts/us/symbol_addrs_audio.txt
+++ b/linker_scripts/us/symbol_addrs_audio.txt
@@ -23,10 +23,10 @@ sSeqCmdWritePos = 0x800C5D44;
 sSeqCmdReadPos = 0x800C5D48;
 sStartSeqDisabled = 0x800C5D4C;
 sSoundModeList = 0x800C5D50;
-sNewAudioSpecId = 0x800C5D54;
+sAudioSpecId = 0x800C5D54;
 D_800C5D58 = 0x800C5D58;
 
-sBaseReverb = 0x800C5D60;
+sEnvReverb = 0x800C5D60;
 sAudioSpecReverb = 0x800C5D64;
 sVolumeSettings = 0x800C5D68;
 D_800C5D6C = 0x800C5D6C;
@@ -39,7 +39,7 @@ sSfxVolMod = 0x800C5E78;
 sPlaylistIndex = 0x800C5E7C;
 sPlaylistTimer = 0x800C5E80;
 sPlaylistCmdIndex = 0x800C5E84;
-D_800C5E88 = 0x800C5E88;
+sEventSfx = 0x800C5E88;
 sSoundTestTracks = 0x800C5EE4;
 sPlaylists = 0x800C5FF4; //type:u16 size:5000
 
@@ -47,7 +47,7 @@ D_800C7380 = 0x800C7380;
 D_800C7384 = 0x800C7384;
 D_800C7388 = 0x800C7388;
 D_800C738C = 0x800C738C;
-D_800C7390 = 0x800C7390;
+sUnkVoiceParam = 0x800C7390;
 D_800C7394 = 0x800C7394;
 D_800C7398 = 0x800C7398;
 D_800C7418 = 0x800C7418;
@@ -67,7 +67,7 @@ gThreadCmdWritePos = 0x800C7C50;
 gThreadCmdReadPos = 0x800C7C54;
 gAudioTaskStartQueue = 0x800C7C58;
 gThreadCmdProcQueue = 0x800C7C5C;
-gAudioUnkQueue = 0x800C7C60;
+gAudioSpecQueue = 0x800C7C60;
 gAudioResetQueue = 0x800C7C64;
 gMaxAbiCmdCnt = 0x800C7C68;
 gWaitingAudioTask = 0x800C7C6C;
@@ -106,7 +106,7 @@ D_80149AD8 = 0x80149AD8;
 D_80149ED8 = 0x80149ED8;
 D_8014A2D8 = 0x8014A2D8;
 D_8014A8D8 = 0x8014A8D8;
-D_8014A958 = 0x8014A958;
+sFreqAnalyzerBars = 0x8014A958;
 sSeqRequests = 0x8014A978;
 sNumSeqRequests = 0x8014A9A0;
 sAudioSeqCmds = 0x8014A9A8;
@@ -115,10 +115,10 @@ sDelayedSeqCmdFlags = 0x8014B708;
 sDelayedSeqCmds = 0x8014B710;
 sSfxChannelState = 0x8014B790;
 sPlayerNoise = 0x8014B850;
-D_8014BA10 = 0x8014BA10;
-D_8014BA20 = 0x8014BA20;
-D_8014BA24 = 0x8014BA24;
-D_8014BA28 = 0x8014BA28;
+sBombFreqMod = 0x8014BA10;
+sBombType = 0x8014BA20;
+sBombState = 0x8014BA24;
+sBombStartFrame = 0x8014BA28;
 
 gAudioContextStart = 0x8014BA40; // size:0x10
 gSynthReverbs = 0x8014BA50; // size:0x750
@@ -212,12 +212,12 @@ gAudioContextEnd = 0x80155D90;//size:0x10
 
 sAudioTaskStartQueue = 0x80155DA0;
 sThreadCmdProcQueue = 0x80155DB8;
-sAudioUnkQueue = 0x80155DD0;
+sAudioSpecQueue = 0x80155DD0;
 sAudioResetQueue = 0x80155DE8;
 gThreadCmdBuffer = 0x80155E00;
 sAudioTaskStartMsg = 0x80156600;
 sThreadCmdProcMsg = 0x80156608;
-sAudioUnkMsg = 0x80156618;
+sAudioSpecMsg = 0x80156618;
 sAudioResetMsg = 0x8015661C;
 
 
@@ -408,8 +408,8 @@ Audio_GetSfxPan = 0x80016CDC;
 Audio_GetSfxFreqMod = 0x80016EE4;
 Audio_SetSfxProperties = 0x80016FF0;
 Audio_UpdateDopplerShift = 0x80017360;
-func_80017494 = 0x80017494;
-func_80017550 = 0x80017550;
+Audio_LoadInstruments = 0x80017494;
+Audio_LoadAquasSequence = 0x80017550;
 Audio_ResetSfxChannelState = 0x80017588;
 Audio_StartSequence = 0x80017600;
 Audio_StopSequence = 0x80017760;
@@ -420,12 +420,12 @@ Audio_GetActiveSeqId = 0x8001839C;
 Audio_SeqCmdNotQueued = 0x80018410;
 Audio_SeqCmdValueNotQueued = 0x80018470;
 Audio_ResetSequenceRequests = 0x800184D4;
-func_800184EC = 0x800184EC;
+Audio_DisableSetupOp = 0x800184EC;
 Audio_SetSequenceFade = 0x800185A0;
 Audio_UpdateActiveSequences = 0x800185F8;
 Audio_SetDelayedSeqCmd = 0x80018E9C;
 Audio_UpdateDelayedSeqCmds = 0x80018EE0;
-func_80018FA4 = 0x80018FA4;
+Audio_HandleReset = 0x80018FA4;
 Audio_ResetActiveSequences = 0x80019068;
 Audio_ResetActiveSequencesAndVolume = 0x800190E4;
 Audio_SetSfxBanksMute = 0x80019158;
@@ -454,8 +454,8 @@ Audio_UpdateVoice = 0x8001AD44;
 Audio_ClearVoice = 0x8001AE58;
 Audio_GetCurrentVoice = 0x8001AE78;
 Audio_GetCurrentVoiceStatus = 0x8001AED4;
-func_8001AF40 = 0x8001AF40;
-func_8001AF50 = 0x8001AF50;
+Audio_SetUnkVoiceParam = 0x8001AF40;
+Audio_UpdateUnkVoiceParam = 0x8001AF50;
 Audio_ResetPlayerFreqMods = 0x8001AF9C;
 Audio_UpdateArwingNoise = 0x8001B014;
 Audio_UpdateLandmasterNoise = 0x8001B454;
@@ -465,31 +465,31 @@ Audio_UpdatePlayerReverb = 0x8001BB74;
 Audio_UpdatePlayerNoise = 0x8001BC20;
 Audio_ResetVoicesAndPlayers = 0x8001BC48;
 Audio_ProcessPlaylist = 0x8001BD0C;
-func_8001BFC0 = 0x8001BFC0;
+Audio_AnalyzeFrequencies = 0x8001BFC0;
 Audio_UpdateFrequencyAnalysis = 0x8001C3EC;
 Audio_StartPlayerNoise = 0x8001C8B8;
-func_8001CA24 = 0x8001CA24;
-func_8001CB80 = 0x8001CB80;
-func_8001CCDC = 0x8001CCDC;
-func_8001CE28 = 0x8001CE28;
-func_8001CEFC = 0x8001CEFC;
-func_8001CF60 = 0x8001CF60;
-func_8001CFA8 = 0x8001CFA8;
-func_8001D034 = 0x8001D034;
-func_8001D0B4 = 0x8001D0B4;
-func_8001D10C = 0x8001D10C;
-func_8001D15C = 0x8001D15C;
-func_8001D1C8 = 0x8001D1C8;
+Audio_StopPlayerNoise = 0x8001CA24;
+Audio_InitBombSfx = 0x8001CB80;
+Audio_PlayBombFlightSfx = 0x8001CCDC;
+Audio_PlayBombExplodeSfx = 0x8001CE28;
+Audio_StartEngineNoise = 0x8001CEFC;
+Audio_StopEngineNoise = 0x8001CF60;
+Audio_SetSfxSpeedModulation = 0x8001CFA8;
+Audio_SetTransposeAndPlaySfx = 0x8001D034;
+Audio_SetModulationAndPlaySfx = 0x8001D0B4;
+Audio_PlaySfxModulated = 0x8001D10C;
+Audio_SetSfxMapModulation = 0x8001D15C;
+Audio_SetHeatAlarmParams = 0x8001D1C8;
 Audio_PlayEventSfx = 0x8001D2FC;
 Audio_StopEventSfx = 0x8001D3A0;
-Audio_SetBaseSfxReverb = 0x8001D400;
+Audio_SetEnvSfxReverb = 0x8001D400;
 Audio_SetBgmParam = 0x8001D410;
 Audio_PlaySequence = 0x8001D444;
 Audio_PlayFanfare = 0x8001D4AC;
-func_8001D520 = 0x8001D520;
-func_8001D638 = 0x8001D638;
-func_8001D6DC = 0x8001D6DC;
-func_8001D780 = 0x8001D780;
+Audio_PlayDeathSequence = 0x8001D520;
+Audio_PlayPauseSfx = 0x8001D638;
+Audio_PlayMapMenuSfx = 0x8001D6DC;
+Audio_RestoreVolumeSettings = 0x8001D780;
 Audio_SetVolume = 0x8001D8A8;
 Audio_PlaySoundTest = 0x8001D8F4;
 Audio_PlaySequenceDistorted = 0x8001D9E0;
@@ -499,8 +499,8 @@ Audio_KillAllSfx = 0x8001DC2C;
 Audio_SetAudioSpec = 0x8001DC6C;
 Audio_PlayBgm = 0x8001DCB4;
 Audio_InitSounds = 0x8001DCE0;
-func_8001DD40 = 0x8001DD40;
-func_8001DE1C = 0x8001DE1C;
+Audio_RestartSeqPlayers = 0x8001DD40;
+Audio_StartReset = 0x8001DE1C;
 Audio_Update = 0x8001DECC;
 
 
@@ -519,7 +519,7 @@ AudioThread_ResetCmdQueue = 0x8001E998;
 AudioThread_ProcessCmds = 0x8001E9AC;
 AudioThread_GetAsyncLoadStatus = 0x8001ECAC;
 AudioThread_GetFontsForSequence = 0x8001ED14;
-func_8001ED34 = 0x8001ED34;
+AudioThread_ResetComplete = 0x8001ED34;
 AudioThread_ResetAudioHeap = 0x8001ED8C;
 AudioThread_PreNMIReset = 0x8001EE00;
 AudioThread_Init = 0x8001EE3C;
diff --git a/linker_scripts/us/symbol_addrs_engine.txt b/linker_scripts/us/symbol_addrs_engine.txt
index 2d93d445..03dd42b3 100644
--- a/linker_scripts/us/symbol_addrs_engine.txt
+++ b/linker_scripts/us/symbol_addrs_engine.txt
@@ -472,7 +472,7 @@ gPrevPlanetSavedTeamShields = 0x801778F0;//size=0x18
 gBoostButton = 0x80177908;
 gTeamDamage = 0x80177910;
 gBrakeButton = 0x80177928;
-gNextPlanetPath = 0x80177930;
+gMissionStatus = 0x80177930;
 gShootButton = 0x80177938;
 gGroundHeight = 0x80177940;
 gBombButton = 0x80177948;
@@ -512,10 +512,10 @@ gVsLockOnTimers = 0x80177B00;
 D_ctx_80177B40 = 0x80177B40;
 gStartAndrossFightTimer = 0x80177B44;
 gMissionNumber = 0x80177B48;
-D_ctx_80177B50 = 0x80177B50;
-D_ctx_80177B70 = 0x80177B70;
-D_ctx_80177B90 = 0x80177B90;
-D_ctx_80177BB0 = 0x80177BB0;
+gMissionTeamStatus = 0x80177B50;
+gMissionHitCount = 0x80177B70;
+gMissionPlanet = 0x80177B90;
+gMissionMedal = 0x80177BB0;
 gControllerRumbleTimers = 0x80177BD0;
 gPlanetPathStatus = 0x80177BD8;
 D_ctx_80177C30 = 0x80177C30;
diff --git a/linker_scripts/us/symbol_addrs_nlib_vars.txt b/linker_scripts/us/symbol_addrs_nlib_vars.txt
index 7df28f31..4bfa4433 100644
--- a/linker_scripts/us/symbol_addrs_nlib_vars.txt
+++ b/linker_scripts/us/symbol_addrs_nlib_vars.txt
@@ -35,33 +35,33 @@ gSegments = 0x800E1FD0;
 gPiMgrCmdQueue = 0x800E2010;
 sPiMgrCmdBuff = 0x800E2028;
 
-gDmaMsgQueue = 0x800E20F0;
+gDmaMesgQueue = 0x800E20F0;
 
 sDmaMsgBuff = 0x800E2108;
 gDmaIOMsg = 0x800E2110;
 gSerialEventQueue = 0x800E2128;
 sSerialEventBuff = 0x800E2140;
-gMainThreadMsgQueue = 0x800E2148;
+gMainThreadMesgQueue = 0x800E2148;
 sMainThreadMsgBuff = 0x800E2160;
-gTaskMsgQueue = 0x800E21E0;
+gTaskMesgQueue = 0x800E21E0;
 sTaskMsgBuff = 0x800E21F8;
-gAudioVImsgQueue = 0x800E2238;
-gAudioTaskMsgQueue = 0x800E2258;
-gGfxVImsgQueue = 0x800E2278;
-gGfxTaskMsgQueue = 0x800E22A0;
+gAudioVImesgQueue = 0x800E2238;
+gAudioTaskMesgQueue = 0x800E2258;
+gGfxVImesgQueue = 0x800E2278;
+gGfxTaskMesgQueue = 0x800E22A0;
 sAudioVImsgBuff = 0x800E2250;
 sAudioTaskMsgBuff = 0x800E2270;
 sGfxVImsgBuff = 0x800E2290;
 sGfxTaskMsgBuff = 0x800E22B8;
-gSerialThreadMsgQueue = 0x800E22C0;
+gSerialThreadMesgQueue = 0x800E22C0;
 sSerialThreadMsgBuff = 0x800E22D8;
-gControllerMsgQueue = 0x800E22F8;
+gControllerMesgQueue = 0x800E22F8;
 sControllerMsgBuff = 0x800E2310;
-gSaveMsgQueue = 0x800E2318;
+gSaveMesgQueue = 0x800E2318;
 sSaveMsgBuff = 0x800E2330;
-gTimerTaskMsgQueue = 0x800E2338;
+gTimerTaskMesgQueue = 0x800E2338;
 sTimerTaskMsgBuff = 0x800E2350;
-gTimerWaitMsgQueue = 0x800E2390;
+gTimerWaitMesgQueue = 0x800E2390;
 sTimerWaitMsgBuff = 0x800E23A8;
 
 gGfxPools = 0x800E23B0; // size:0x55AA0