Browse Source

Fix typo in header comment. Add mention of EngineDefs.h in documentation.

Lasse Öörni 9 years ago
parent
commit
bbee668dfa
3 changed files with 4 additions and 3 deletions
  1. 2 2
      Docs/Reference.dox
  2. 1 1
      Source/Urho3D/Audio/Audio.h
  3. 1 0
      Source/Urho3D/Audio/AudioDefs.h

+ 2 - 2
Docs/Reference.dox

@@ -178,7 +178,7 @@ There is only one parameter pair in the above example, however, this overload me
 
 Before a Urho3D application can enter its main loop, the Engine subsystem object must be created and initialized by calling its \ref Engine::Initialize "Initialize()" function. Parameters sent in a VariantMap can be used to direct how the Engine initializes itself and the subsystems. One way to configure the parameters is to parse them from the command line like the Urho3DPlayer application does: this is accomplished by the helper function \ref Engine::ParseParameters "ParseParameters()".
 
-The full list of supported parameters, their datatypes and default values:
+The full list of supported parameters, their datatypes and default values: (also defined as constants in Engine/EngineDefs.h)
 
 - Headless (bool) Headless mode enable. Default false.
 - LogLevel (int) %Log verbosity level. Default LOG_INFO in release builds and LOG_DEBUG in debug builds.
@@ -186,7 +186,7 @@ The full list of supported parameters, their datatypes and default values:
 - LogName (string) %Log filename. Default "Urho3D.log".
 - FrameLimiter (bool) Whether to cap maximum framerate to 200 (desktop) or 60 (Android/iOS.) Default true.
 - WorkerThreads (bool) Whether to create worker threads for the %WorkQueue subsystem according to available CPU cores. Default true.
-- EventProfiler (bool) Whether to create the EventProfiler subsystem. Default true.
+- %EventProfiler (bool) Whether to create the EventProfiler subsystem. Default true.
 - ResourcePrefixPaths (string) A semicolon-separated list of resource prefix paths to use. If not specified then the default prefix path is set to executable path. The resource prefix paths can also be defined using URHO3D_PREFIX_PATH env-var. When both are defined, the paths set by -pp takes higher precedence.
 - ResourcePaths (string) A semicolon-separated list of resource paths to use. If corresponding packages (ie. Data.pak for Data directory) exist they will be used instead. Default "Data;CoreData".
 - ResourcePackages (string) A semicolon-separated list of resource packages to use. Default empty.

+ 1 - 1
Source/Urho3D/Audio/Audio.h

@@ -115,7 +115,7 @@ public:
     /// Mix sound sources into the buffer.
     void MixOutput(void* dest, unsigned samples);
 
-    /// Final multiplier for for audio byte conversion.
+    /// Final multiplier for audio byte conversion.
 #ifdef __EMSCRIPTEN__
     static const int SAMPLE_SIZE_MUL = 2;
 #else

+ 1 - 0
Source/Urho3D/Audio/AudioDefs.h

@@ -33,4 +33,5 @@ static const String SOUND_EFFECT = "Effect";
 static const String SOUND_AMBIENT = "Ambient";
 static const String SOUND_VOICE = "Voice";
 static const String SOUND_MUSIC = "Music";
+
 }