Added better comments to console methods

Improved the comments on two console methods so when using them it is
clearer what to expect.
This commit is contained in:
Nathan Bowhay 2015-02-02 12:50:34 -08:00
parent 014b566014
commit fbc6bcea20

View file

@ -344,7 +344,7 @@ DefineConsoleMethod( GuiPopUpMenuCtrl, forceClose, void, (), , "")
object->closePopUp(); object->closePopUp();
} }
DefineConsoleMethod( GuiPopUpMenuCtrl, getSelected, S32, (), , "") DefineConsoleMethod( GuiPopUpMenuCtrl, getSelected, S32, (), , "Gets the selected index")
{ {
return object->getSelected(); return object->getSelected();
} }
@ -430,7 +430,7 @@ DefineConsoleMethod( GuiPopUpMenuCtrl, setEnumContent, void, (const char * class
//------------------------------------------------------------------------------ //------------------------------------------------------------------------------
DefineConsoleMethod( GuiPopUpMenuCtrl, findText, S32, (const char * text), , "(string text)" DefineConsoleMethod( GuiPopUpMenuCtrl, findText, S32, (const char * text), , "(string text)"
"Returns the position of the first entry containing the specified text.") "Returns the position of the first entry containing the specified text or -1 if not found.")
{ {
return( object->findText( text ) ); return( object->findText( text ) );
} }