From dd9b788ab47a01be36f16e1a5a72ed6617117cee Mon Sep 17 00:00:00 2001 From: Nathan Bowhay Date: Mon, 2 Feb 2015 15:31:38 -0800 Subject: [PATCH] More console method docs More documentation for console methods in doxygen format. --- Engine/source/gui/core/guiTypes.cpp | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/Engine/source/gui/core/guiTypes.cpp b/Engine/source/gui/core/guiTypes.cpp index f221a0d0a..dbf96c517 100644 --- a/Engine/source/gui/core/guiTypes.cpp +++ b/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 ) ); } //-----------------------------------------------------------------------------