Browse Source

Fixed comment

fixed an incomplete comment/documentation for displaySplashWindow.
Nathan Bowhay 10 years ago
parent
commit
d5a6e15cfe
1 changed files with 1 additions and 0 deletions
  1. 1 0
      Engine/source/console/consoleFunctions.cpp

+ 1 - 0
Engine/source/console/consoleFunctions.cpp

@@ -1598,6 +1598,7 @@ DefineEngineFunction( gotoWebPage, void, ( const char* address ),,
 DefineEngineFunction( displaySplashWindow, bool, (const char* path), ("art/gui/splash.bmp"),
 DefineEngineFunction( displaySplashWindow, bool, (const char* path), ("art/gui/splash.bmp"),
    "Display a startup splash window suitable for showing while the engine still starts up.\n\n"
    "Display a startup splash window suitable for showing while the engine still starts up.\n\n"
    "@note This is currently only implemented on Windows.\n\n"
    "@note This is currently only implemented on Windows.\n\n"
+   "@param path	relative path to splash screen image to display.\n"
    "@return True if the splash window could be successfully initialized.\n\n"
    "@return True if the splash window could be successfully initialized.\n\n"
    "@ingroup Platform" )
    "@ingroup Platform" )
 {
 {