瀏覽代碼

Added better comments to console methods

Improved the comments on two console methods so when using them it is
clearer what to expect.
Nathan Bowhay 10 年之前
父節點
當前提交
fbc6bcea20
共有 1 個文件被更改,包括 2 次插入2 次删除
  1. 2 2
      Engine/source/gui/controls/guiPopUpCtrl.cpp

+ 2 - 2
Engine/source/gui/controls/guiPopUpCtrl.cpp

@@ -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 ) );   
 }
 }