Merge pull request #561 from signmotion/filesystem-correct-docs

Corrected docs for scripts in the group FileSystem: fileBase() and fileName().
This commit is contained in:
Thomas Fischer 2014-03-15 15:16:28 +01:00
commit 1ce77dc619

View file

@ -599,10 +599,10 @@ DefineEngineFunction(fileExt, String, ( const char* fileName ),,
} }
DefineEngineFunction(fileBase, String, ( const char* fileName ),, DefineEngineFunction(fileBase, String, ( const char* fileName ),,
"@brief Get the base of a file name (removes extension)\n\n" "@brief Get the base of a file name (removes extension and path)\n\n"
"@param fileName Name and path of file to check\n" "@param fileName Name and path of file to check\n"
"@return String containing the file name, minus extension\n" "@return String containing the file name, minus extension and path\n"
"@ingroup FileSystem") "@ingroup FileSystem")
{ {
@ -626,10 +626,10 @@ DefineEngineFunction(fileBase, String, ( const char* fileName ),,
} }
DefineEngineFunction(fileName, String, ( const char* fileName ),, DefineEngineFunction(fileName, String, ( const char* fileName ),,
"@brief Get the file name of a file (removes extension and path)\n\n" "@brief Get only the file name of a path and file name string (removes path)\n\n"
"@param fileName Name and path of file to check\n" "@param fileName Name and path of file to check\n"
"@return String containing the file name, minus extension and path\n" "@return String containing the file name, minus the path\n"
"@ingroup FileSystem") "@ingroup FileSystem")
{ {
S32 pathLen = dStrlen( fileName ); S32 pathLen = dStrlen( fileName );