Doxygen: fixed a lot of warnings

Redundant docs simply deleted.
GUi_GameControls: deleted unused variable `m_text_all_active` - leftover from removed .map file combobox.

doc/doxygen/MainPage.h

@@ -8,8 +8,7 @@
  *
  * For reference manual, see module @ref ScriptSideAPIs.
  *
- * Rigs of Rods supports scripting with <a href="http://angelcode.com/angelscript/">AngelScript</a>
- * and features an expanding @ref ScriptAPI "interface to the game". All developers are invited
+ * Rigs of Rods supports scripting with <a href="http://angelcode.com/angelscript/">AngelScript</a>. All developers are invited
  * to try archieve their goal via scripting if possible. This documentation intentionally displays
  * the AngelScript interface alongside code to highlight that they match very closely
  * and it's worthwile for the reader gain further insight into things and make/suggest enhancements.

source/main/gfx/MovableText.cpp

@@ -21,7 +21,7 @@
 /// @file 
 /// @brief This creates a billboarding object that displays a text.
 /// @author  2003 by cTh see gavocanov@rambler.ru
-/// @update  2006 by barraq see nospam@barraquand.com
+/// @author  2006 by barraq see nospam@barraquand.com
 
 #include "MovableText.h"
 

source/main/gfx/hydrax/CfgFileManager.h

@@ -39,143 +39,74 @@ namespace Hydrax
 {
 	class Hydrax;
 
-	/** Config file manager.
-	    Class to load/save all Hydrax options from/to a config file
+	/** Class to load/save all Hydrax options from/to a config file
 	 */
 	class CfgFileManager
 	{
 	public:
-		/** Constructor
-		    @param h Hydrax parent pointer
-		 */
 		CfgFileManager(Hydrax *h);
-
-		/** Destructor
-		 */
         ~CfgFileManager();
 
 		/** Load hydrax cfg file
-		    @param File File name
 			@return false if an error has been ocurred(Check the log file in this case).
 		 */
 		const bool load(const Ogre::String& File) const;
 
 		/** Save current hydrax config to a file
-		    @param File Destination file name
-			@param Path File path
 			@return false if an error has been ocurred(Check the log file in this case).
 		 */
 		const bool save(const Ogre::String& File, const Ogre::String& Path = "") const;
 
-		/** <int> Get the cfg string
-		    @param Name Parameter name
-		    @param Value Parameter value
-			@return int cfg string
-		 */
 		static Ogre::String _getCfgString(const Ogre::String& Name, const int& Value);
-
-		/** <float> Get the cfg string
-		    @param Name Parameter name
-		    @param Value Parameter value
-			@return Ogre::Real cfg string
-		 */
 		static Ogre::String _getCfgString(const Ogre::String& Name, const Ogre::Real& Value);
-
-		/** <bool> Get the cfg string
-		    @param Name Parameter name
-		    @param Value Parameter value
-			@return bool cfg string
-		 */
 		static Ogre::String _getCfgString(const Ogre::String& Name, const bool& Value);
-
-		/** <vector2> Get the cfg string
-		    @param Name Parameter name
-		    @param Value Parameter value
-			@return Ogre::Vector2 cfg string
-		 */
 		static Ogre::String _getCfgString(const Ogre::String& Name, const Ogre::Vector2& Value);
-
-		/** <vector3> Get the cfg string
-		    @param Name Parameter name
-		    @param Value Parameter value
-			@return Ogre::Vector3 cfg string
-		 */
 		static Ogre::String _getCfgString(const Ogre::String& Name, const Ogre::Vector3& Value);
-
-		/** <size> Get the cfg string
-		    @param Name Parameter name
-		    @param Value Parameter value
-			@return Hydrax::Size cfg string
-		 */
 		static Ogre::String _getCfgString(const Ogre::String& Name, const Size& Value);
 
 		/** Get int value
-		    @param CfgFile Config file
-		    @param Name Parameter name
-			@return int value
 			@remarks if the parameter isn't found or the data type is not an int value, return 0 as default
 		 */
 		static int _getIntValue(Ogre::ConfigFile& CfgFile, const Ogre::String Name);
 
 		/** Get float value
-		    @param CfgFile Config file
-		    @param Name Parameter name
-			@return float value
 			@remarks if the parameter isn't found or the data type is not a float value, return 0 as default
 		 */
 		static Ogre::Real _getFloatValue(Ogre::ConfigFile& CfgFile, const Ogre::String Name);
 
 		/** Get bool value
-		    @param CfgFile Config file
-		    @param Name Parameter name
-			@return bool value
 			@remarks if the parameter isn't found or the data type is not a bool value, return false as default
 		 */
 		static bool _getBoolValue(Ogre::ConfigFile& CfgFile, const Ogre::String Name);
 
 		/** Get vector2 value
-		    @param CfgFile Config file
-		    @param Name Parameter name
-			@return vector2 value
 			@remarks if the parameter isn't found or the data type is not an int value, returns (0,0) as default
 		 */
 		static Ogre::Vector2 _getVector2Value(Ogre::ConfigFile& CfgFile, const Ogre::String Name);
 
 		/** Get vector3 value
-		    @param CfgFile Config file
-		    @param Name Parameter name
-			@return vector3 value
 			@remarks if the parameter isn't found or the data type is not an int value, returns (0,0,0) as default
 		 */
 		static Ogre::Vector3 _getVector3Value(Ogre::ConfigFile& CfgFile, const Ogre::String Name);
 
 		/** Get size value
-		    @param CfgFile Config file
-		    @param Name Parameter name
-			@return size value
 			@remarks if the parameter isn't found or the data type is not an int value, returns (0,0) as default
 		 */
 		static Size _getSizeValue(Ogre::ConfigFile& CfgFile, const Ogre::String Name);
 
 		/** Check is a std::vector<Ogre::String> contains a specified Ogre::String
-		    @param List String list
-			@param Find String to find
 			@return true if it's contained, false if not
 		 */
 		static bool _isStringInList(const Ogre::StringVector &List, const Ogre::String &Find);
 
 	private:
 		/** Save a string in file
-		    @param Data Data
-			@param File Destination file
-			@param Path File path
 			@return false if an error has ocurred
 		 */
 		const bool _saveToFile(const Ogre::String& Data, const Ogre::String& File, const Ogre::String& Path) const;
 
 		/** Load a cfg file in an Ogre::ConfigFile
-		    @param File File name
-			@param Result, std::pair<bool, Ogre::ConfigFile&> First: False if the file isn't in the Hydrax resource group, Second: Ogre::ConfigFile
+			@param Result, First: False if the file isn't in the Hydrax resource group, Second: Ogre::ConfigFile
 		 */
 		const void _loadCfgFile(const Ogre::String& File, std::pair<bool,Ogre::ConfigFile> &Result) const;
 
@@ -205,7 +136,6 @@ namespace Hydrax
 		const Ogre::String _getVersionCfgString() const;
 
 		/** Check hydrax version cfg file
-		    @param CfgFile Config file
 		    @return true if it's the same version, false if not.
 		 */
 		const bool _checkVersion(Ogre::ConfigFile& CfgFile) const;

source/main/gfx/hydrax/FFT.h

@@ -191,7 +191,6 @@ namespace Hydrax{ namespace Noise
 		void saveCfg(Ogre::String &Data);
 
 		/** Load config
-		    @param CgfFile Ogre::ConfigFile reference
 			@return True if is the correct noise config
 		 */
 		bool loadCfg(Ogre::ConfigFile &CfgFile);

source/main/gfx/hydrax/Hydrax.h

@@ -159,19 +159,12 @@ namespace Hydrax
          */
         void setFullReflectionDistance(const Ogre::Real &FullReflectionDistance);
 
-        /** Set global transparency
-            @param GlobalTransparency Global transparency distance
-         */
-        void setGlobalTransparency(const Ogre::Real &GlobalTransparency);
+        void setGlobalTransparency(const Ogre::Real &GlobalTransparencyDistance);
 
-		/** Set water color
-            @param DepthColor Water color
-         */
         void setWaterColor(const Ogre::Vector3 &WaterColor);
 
         /** Set normal distortion
-            @param NormalDistortion Normal distortion
-            @remarks Value will bi very short, like 0.025
+            @param NormalDistortion use low value, like 0.025
          */
         void setNormalDistortion(const Ogre::Real &NormalDistortion);
 

source/main/gfx/hydrax/MaterialManager.h

@@ -351,14 +351,7 @@ namespace Hydrax
 		 */
 		bool _createUnderwaterCompositor(const HydraxComponent &Components, const Options &Options);
 
-		/** Create a simple color material
-		    @param Colour Material color
-			@param MT Material type
-			@param Name Material name
-			@param DepthCheck Depth check enabled
-			@param DepthWrite Depth write enabled
-		 */
-		bool _createSimpleColorMaterial(const Ogre::ColourValue& Color, const MaterialType& MT, const Ogre::String& Name, const bool& DepthCheck = true, const bool& DepthWrite = true);
+		bool _createSimpleColorMaterial(const Ogre::ColourValue& MaterialColor, const MaterialType& MT, const Ogre::String& MaterialName, const bool& DepthCheck = true, const bool& DepthWrite = true);
 
 		/// Is createMaterials() already called?
 		bool mCreated;

source/main/gfx/hydrax/Module.h

@@ -89,7 +89,6 @@ namespace Hydrax{ namespace Module
 		virtual void saveCfg(Ogre::String &Data);
 
 		/** Load config
-		    @param CgfFile Ogre::ConfigFile reference
 			@return True if is the correct module config
 		 */
 		virtual bool loadCfg(Ogre::ConfigFile &CfgFile);

source/main/gfx/hydrax/Noise.h

@@ -82,7 +82,6 @@ namespace Hydrax{ namespace Noise
 		virtual void saveCfg(Ogre::String &Data);
 
 		/** Load config
-		    @param CgfFile Ogre::ConfigFile reference
 			@return True if is the correct noise config
 		 */
 		virtual bool loadCfg(Ogre::ConfigFile &CfgFile);

source/main/gfx/hydrax/Perlin.h

@@ -202,7 +202,6 @@ namespace Hydrax{ namespace Noise
 		void saveCfg(Ogre::String &Data);
 
 		/** Load config
-		    @param CgfFile Ogre::ConfigFile reference
 			@return True if is the correct noise config
 		 */
 		bool loadCfg(Ogre::ConfigFile &CfgFile);

source/main/gfx/hydrax/ProjectedGrid.h

@@ -188,7 +188,6 @@ namespace Hydrax{ namespace Module
 		void saveCfg(Ogre::String &Data);
 
 		/** Load config
-		    @param CgfFile Ogre::ConfigFile reference
 			@return True if is the correct module config
 		 */
 		bool loadCfg(Ogre::ConfigFile &CfgFile);

source/main/gfx/hydrax/RadialGrid.h

@@ -185,7 +185,6 @@ namespace Hydrax{ namespace Module
 		void saveCfg(Ogre::String &Data);
 
 		/** Load config
-		    @param CgfFile Ogre::ConfigFile reference
 			@return True if is the correct module config
 		 */
 		bool loadCfg(Ogre::ConfigFile &CfgFile);

source/main/gfx/hydrax/Real.h

@@ -148,7 +148,6 @@ class Real : public Noise
     void saveCfg(Ogre::String &Data);
 
     /** Load config
-        @param CgfFile Ogre::ConfigFile reference
         @return True if is the correct noise config
      */
     bool loadCfg(Ogre::ConfigFile &CfgFile);