Selaa lähdekoodia

shellExecute return documentation

Added documentation to shellExecute about bool that is returned.
Nathan Bowhay 10 vuotta sitten
vanhempi
commit
27fa97f44d
1 muutettua tiedostoa jossa 1 lisäystä ja 0 poistoa
  1. 1 0
      Engine/source/platformWin32/winExec.cpp

+ 1 - 0
Engine/source/platformWin32/winExec.cpp

@@ -141,6 +141,7 @@ DefineConsoleFunction( shellExecute, bool, (const char * executable, const char
 				"@param executable Name of the executable or batch file\n"
 				"@param executable Name of the executable or batch file\n"
 				"@param args Optional list of arguments, in string format, to pass to the executable\n"
 				"@param args Optional list of arguments, in string format, to pass to the executable\n"
 				"@param directory Optional string containing path to output or shell\n"
 				"@param directory Optional string containing path to output or shell\n"
+				"@return true if executed, false if not\n"
 				"@ingroup Platform")
 				"@ingroup Platform")
 {
 {
    ExecuteThread *et = new ExecuteThread( executable, args, directory );
    ExecuteThread *et = new ExecuteThread( executable, args, directory );