shellExecute return documentation

Added documentation to shellExecute about bool that is returned.
This commit is contained in:
Nathan Bowhay 2015-02-11 09:52:59 -08:00
parent 4f87422392
commit 27fa97f44d

View file

@ -141,6 +141,7 @@ DefineConsoleFunction( shellExecute, bool, (const char * executable, const char
"@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 directory Optional string containing path to output or shell\n"
"@return true if executed, false if not\n"
"@ingroup Platform")
{
ExecuteThread *et = new ExecuteThread( executable, args, directory );