Browse Source

More console method docs

More documentation for console methods in doxygen format.
Nathan Bowhay 10 years ago
parent
commit
dd9b788ab4
1 changed files with 5 additions and 2 deletions
  1. 5 2
      Engine/source/gui/core/guiTypes.cpp

+ 5 - 2
Engine/source/gui/core/guiTypes.cpp

@@ -695,9 +695,12 @@ bool GuiControlProfile::loadFont()
    return true;
 }
 
-DefineConsoleMethod( GuiControlProfile, getStringWidth, S32, ( const char * pString ), , "( pString )" )
+DefineEngineMethod( GuiControlProfile, getStringWidth, S32, (const char* string),,
+   "Get the width of the string in pixels.\n"
+   "@param string String to get the width of."
+   "@return width of the string in pixels." )
 {
-    return object->mFont->getStrNWidth( pString, dStrlen( pString ) );
+   return object->mFont->getStrNWidth( string, dStrlen( string ) );
 }
 
 //-----------------------------------------------------------------------------