Code review comment fixes

Author: garethyr

Entities/SoundContainer.h

@@ -53,7 +53,7 @@ namespace RTE {
 		/// <param name="soundFilePath">The path to a sound to add to the first SoundSet of this SoundContainer.</param>
 		/// <param name="immobile">Whether this SoundContainer's sounds will be treated as immobile, i.e. they won't be affected by 3D sound manipulation.</param>
 		/// <param name="affectedByGlobalPitch">Whether this SoundContainer's sounds' frequency will be affected by the global pitch.</param>
-		/// <returns>An error return value signaing success or any particular failure. Anything below 0 is an error signal.</returns>
+		/// <returns>An error return value signaling success or any particular failure. Anything below 0 is an error signal.</returns>
 		int Create(const std::string &soundFilePath, bool immobile = false, bool affectedByGlobalPitch = true) { m_TopLevelSoundSet.AddSound(soundFilePath, true); SetImmobile(immobile); SetAffectedByGlobalPitch(affectedByGlobalPitch); return 0; }
 #pragma endregion
 
@@ -210,7 +210,7 @@ namespace RTE {
 		/// Gets the position at which this SoundContainer's sound will be played. Note that its individual sounds can be offset from this.
 		/// </summary>
 		/// <returns>The position of this SoundContainer.</returns>
-		const Vector &GetPosition() const { return m_Pos; }
+		const Vector & GetPosition() const { return m_Pos; }
 
 		/// <summary>
 		/// Sets the position of the SoundContainer's sounds while they're playing.

Entities/SoundSet.cpp

@@ -182,7 +182,9 @@ namespace RTE {
 		if (!hasAnySounds && includeSubSoundSets) {
 			for (const SoundSet &subSoundSet : m_SubSoundSets) {
 				hasAnySounds = subSoundSet.HasAnySounds();
-				if (hasAnySounds) { break; }
+				if (hasAnySounds) {
+					break;
+				}
 			}
 		}
 		return hasAnySounds;

Entities/SoundSet.h

@@ -33,8 +33,8 @@ namespace RTE {
 			ContentFile SoundFile;
 			FMOD::Sound *SoundObject;
 			Vector Offset = Vector();
-			float MinimumAudibleDistance = 0;
-			float AttenuationStartDistance = -1;
+			float MinimumAudibleDistance = 0.0F;
+			float AttenuationStartDistance = -1.0F;
 		};
 
 #pragma region Creation
@@ -66,7 +66,7 @@ namespace RTE {
 #pragma region INI Handling
 		/// <summary>
 		/// Handles reading a SoundData from INI, loading it in as a ContentFile and into FMOD, and reading any of its subproperties.
-		/// /////////Does not add the created SoundData to a this SoundSet.
+		/// Does not add the created SoundData to a this SoundSet.
 		/// </summary>
 		/// <param name="reader">A Reader lined up to the value of the property to be read.</param>
 		/// <returns>SoundData for the newly read sound.</returns>
@@ -153,14 +153,14 @@ namespace RTE {
 		void SetSoundSelectionCycleMode(SoundSelectionCycleMode newSoundSelectionCycleMode) { m_SoundSelectionCycleMode = newSoundSelectionCycleMode; }
 
 		/// <summary>
-		/// Filles the passed in vector with the flattened SoundData in the SoundSet, optionally only getting currently selected SoundData.
+		/// Fills the passed in vector with the flattened SoundData in the SoundSet, optionally only getting currently selected SoundData.
 		/// </summary>
 		/// <param name="flattenedSoundData">A reference vector of SoundData references to be filled with this SoundSet's flattened SoundData.</param>
 		/// <param name="onlyGetSelectedSoundData">Whether to only get SoundData that is currently selected, or to get all SoundData in this SoundSet.</param>
 		void GetFlattenedSoundData(std::vector<SoundData *> &flattenedSoundData, bool onlyGetSelectedSoundData);
 
 		/// <summary>
-		/// Filles the passed in vector with the flattened SoundData in the SoundSet, optionally only getting currently selected SoundData.
+		/// Fills the passed in vector with the flattened SoundData in the SoundSet, optionally only getting currently selected SoundData.
 		/// </summary>
 		/// <param name="flattenedSoundData">A reference vector of SoundData references to be filled with this SoundSet's flattened SoundData.</param>
 		/// <param name="onlyGetSelectedSoundData">Whether to only get SoundData that is currently selected, or to get all SoundData in this SoundSet.</param>

Managers/AudioMan.cpp

@@ -17,9 +17,9 @@ namespace RTE {
 		m_CurrentActivityHumanPlayerPositions.clear();
 		m_SoundChannelMinimumAudibleDistances.clear();
 
-		m_MusicVolume = 1.0;
-		m_SoundsVolume = 1.0;
-		m_GlobalPitch = 1.0;
+		m_MusicVolume = 1.0F;
+		m_SoundsVolume = 1.0F;
+		m_GlobalPitch = 1.0F;
 
 		m_MusicPath.clear();
 		m_MusicPlayList.clear();

Managers/AudioMan.h

@@ -15,7 +15,7 @@
 namespace RTE {
 
 	/// <summary>
-	/// The singleton manager of the WAV sound effects and OGG music playback.
+	/// The singleton manager of sound effect and music playback.
 	/// </summary>
 	class AudioMan : public Singleton<AudioMan> {
 		friend class SoundContainer;
@@ -161,7 +161,7 @@ namespace RTE {
 		/// <param name="pitch">New global pitch, limited to 8 octaves up or down (i.e. 0.125 - 8). Defaults to 1.</param>
 		/// <param name="includeImmobileSounds">Whether to include immobile sounds (normally used for GUI and so on) in global pitch modification. Defaults to false.</param>
 		/// <param name="includeMusic">Whether to include the music in global pitch modification. Defaults to false.</param>
-		void SetGlobalPitch(float pitch = 1.0, bool includeImmobileSounds = false, bool includeMusic = false);
+		void SetGlobalPitch(float pitch = 1.0F, bool includeImmobileSounds = false, bool includeMusic = false);
 #pragma endregion
 
 #pragma region Music Getters and Setters
@@ -181,7 +181,7 @@ namespace RTE {
 		/// Sets the music to a specific volume. Does not affect sounds.
 		/// </summary>
 		/// <param name="volume">The desired volume scalar. 0.0-1.0.</param>
-		void SetMusicVolume(float volume = 1.0) { m_MusicVolume = std::clamp(volume, 0.0F, 1.0F); if (m_AudioEnabled) { m_MusicChannelGroup->setVolume(m_MusicVolume); } }
+		void SetMusicVolume(float volume = 1.0F) { m_MusicVolume = std::clamp(volume, 0.0F, 1.0F); if (m_AudioEnabled) { m_MusicChannelGroup->setVolume(m_MusicVolume); } }
 
 		/// <summary>
 		/// Sets the music to a specific volume, but it will only last until a new song is played. Useful for fading etc.
@@ -243,7 +243,7 @@ namespace RTE {
 		/// <param name="filePath">The path to the music file to play.</param>
 		/// <param name="loops">The number of times to loop the song. 0 means play once. -1 means play infinitely until stopped.</param>
 		/// <param name="volumeOverrideIfNotMuted">The volume override for music for this song only, if volume is not muted. < 0 means no override.</param>
-		void PlayMusic(const char *filePath, int loops = -1, float volumeOverrideIfNotMuted = -1.0);
+		void PlayMusic(const char *filePath, int loops = -1, float volumeOverrideIfNotMuted = -1.0F);
 
 		/// <summary>
 		/// Plays the next music stream in the queue, if any is queued.
@@ -350,7 +350,7 @@ namespace RTE {
 		/// <param name="loops">LoopsOrSilence counter or, if state is silence, the length of the silence.</param>
 		/// <param name="position">Music playback position.</param>
 		/// <param name="pitch">Pitch value.</param>
-		void RegisterMusicEvent(int player, NetworkMusicState state, const char *filepath, int loopsOrSilence = 0, float position = 0, float pitch = 1);
+		void RegisterMusicEvent(int player, NetworkMusicState state, const char *filepath, int loopsOrSilence = 0, float position = 0, float pitch = 1.0F);
 
 		/// <summary>
 		/// Fills the list with sound events happened for the specified network player.

System/ContentFile.h

@@ -140,14 +140,6 @@ namespace RTE {
 		/// <param name="asyncLoading">Whether to enable FMOD asynchronous loading or not. Should be disabled for loading audio files with Lua AddSound.
 		/// <returns>Pointer to the FSOUND_SAMPLE loaded from disk.</returns>
 		FMOD::Sound * GetAsSound(bool abortGameForInvalidSound = true, bool asyncLoading = true);
-
-		/// <summary>
-		/// Loads and transfers the data represented by this ContentFile object as an FMOD FSOUND_SAMPLE. Ownership of the FSOUND_SAMPLE is NOT transferred!
-		/// </summary>
-		/// <param name="abortGameForInvalidSound">Whether to abort the game if the sound couldn't be added, or just show a console error</param>
-		/// <param name="asyncLoading">Whether to enable FMOD asynchronous loading or not. Should be disabled for loading audio files with Lua AddSound.
-		/// <returns>Pointer to the FSOUND_SAMPLE loaded from disk.</returns>
-		FMOD::Sound * LoadAndReleaseSound(bool abortGameForInvalidSound, bool asyncLoading);
 #pragma endregion
 
 #pragma region Class Info
@@ -198,7 +190,7 @@ namespace RTE {
 		/// <param name="abortGameForInvalidSound">Whether to abort the game if the sound couldn't be added, or just show a console error. Default true.</param>
 		/// <param name="asyncLoading">Whether to enable FMOD asynchronous loading or not. Should be disabled for loading audio files with Lua AddSound.
 		/// <returns>Pointer to the FSOUND_SAMPLE loaded from disk.</returns>
-		FMOD::Sound * LoadAndReleaseSample(bool abortGameForInvalidSound = true, bool asyncLoading = true);
+		FMOD::Sound * LoadAndReleaseSound(bool abortGameForInvalidSound = true, bool asyncLoading = true);
 #pragma endregion
 
 		/// <summary>