From: John L. <jr...@us...> - 2007-06-17 17:17:51
|
Update of /cvsroot/wxlua/wxLua/docs In directory sc8-pr-cvs9.sourceforge.net:/tmp/cvs-serv14496/wxLua/docs Modified Files: FAQ.html wxluaref.html Log Message: Cleanup in the bindings file, make comments more uniform for wxluaref.html Make the genidocs.lua nicer, better colors and have it use it's own rules file. It can be used to generate a generic ref manual for any bindings now. Index: wxluaref.html =================================================================== RCS file: /cvsroot/wxlua/wxLua/docs/wxluaref.html,v retrieving revision 1.24 retrieving revision 1.25 diff -C2 -d -r1.24 -r1.25 *** wxluaref.html 16 Jun 2007 06:21:43 -0000 1.24 --- wxluaref.html 17 Jun 2007 17:17:38 -0000 1.25 *************** *** 2,565 **** <html> <head> ! <meta content="text/html; charset=ISO-8859-1" http-equiv="content-type"> ! <title>wxLua Class Reference</title> ! <meta content="John Labenski" name="author"> </head> <body> ! <h1>wxLua 2.8.4.0 Class Reference for wxWidgets 2.8.4</h1> ! <h2>wxWidgets Classes</h2> ! <a href="#wxANIHandler">wxANIHandler</a> - (Not in wxWidgets reference manual)<br> [...36762 lines suppressed...] ! <font color=#006666> <i>%define_event</i> wxEVT_WXLUA_DEBUGGER_TABLE_ENUM <font color=#009900>// EVT_WXLUA_DEBUGGER_TABLE_ENUM(id, fn)</font></font><br> ! <font color=#006666> <i>%define_event</i> wxEVT_WXLUA_DEBUGGER_EVALUATE_EXPR <font color=#009900>// EVT_WXLUA_DEBUGGER_EVALUATE_EXPR(id, fn)</font></font><br> <br> int GetLineNumber() const<br> *************** *** 18379,18384 **** <a href="#wxString">wxString</a> GetFileName() const<br> <a href="#wxString">wxString</a> GetMessage() const<br> ! //const wxLuaDebugData GetDebugData() const<br> ! </blockquote><font color=#AA0000><i>%endclass</i></font><br> </body> ! </html> --- 21809,21814 ---- <a href="#wxString">wxString</a> GetFileName() const<br> <a href="#wxString">wxString</a> GetMessage() const<br> ! <font color=#009900>//const wxLuaDebugData GetDebugData() const</font><br> ! </blockquote><font color=#DD0000><font color=#DD0000><i>%endclass</i></font></font><br> </body> ! </html> \ No newline at end of file Index: FAQ.html =================================================================== RCS file: /cvsroot/wxlua/wxLua/docs/FAQ.html,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** FAQ.html 16 Jun 2007 06:21:43 -0000 1.1 --- FAQ.html 17 Jun 2007 17:17:38 -0000 1.2 *************** *** 3,7 **** <meta content="text/html; charset=ISO-8859-1" http-equiv="content-type"><title>wxLua FAQ</title> <meta content="John Labenski" name="author"></head> - <body><h2><u>wxLua FAQ</u></h2> --- 3,6 ---- *************** *** 12,16 **** I use wxLua as script interpreter embedded in my own C++ applications?</a></li> </ol> <li><a href="#Programming_in_wxLua">Programming ! in wxLua</a></li><ol><li><a href="#wxStrings">wxStrings?</a></li><li><a href="#wxArrayString_and_wxSortedArrayString">wxArrayString and wxSortedArrayString?</a></li><li><a href="#wxArrayInt">wxArrayInt?</a></li><li><a href="#When_and_how_should_you_delete_objects">When and how should you delete objects?</a></li></ol> </ol><hr size="2" width="100%"> <ol> <li> <h3><a name="Why_wxLua"></a>Why --- 11,15 ---- I use wxLua as script interpreter embedded in my own C++ applications?</a></li> </ol> <li><a href="#Programming_in_wxLua">Programming ! in wxLua</a></li><ol><li><a href="#wxStrings">wxStrings?</a></li><li><a href="#wxArrayString_and_wxSortedArrayString">wxArrayString and wxSortedArrayString?</a></li><li><a href="#wxArrayInt">wxArrayInt?</a></li><li><a href="#When_and_how_should_you_delete_objects">When and how should you delete() objects?</a></li><li><a href="#Why_do_the_samples_use_the_function">Why do the samples use the function main() is it special to wxLua?</a></li></ol> </ol><hr size="2" width="100%"> <ol> <li> <h3><a name="Why_wxLua"></a>Why *************** *** 49,53 **** that return wxArrayStrings or wxSortedArrayStrings will return a wxArrayString or wxSortedArrayString unless specified otherwise in ! wxluaref.html</li></ul><li><h4><a name="wxArrayInt"></a>wxArrayInt?</h4></li><ul><li>All functions that take a wxArrayInt can also take a numerically indexed table of numbers.</li><li>Functions that return wxArrayInts will return a wxArrayInt unless specified otherwise in wxluaref.html.</li></ul><li><h4><a name="When_and_how_should_you_delete_objects"></a>When and how should you delete objects?</h4></li><ul><li>You should read the section "C++ Classes CLASS_NAME" in the "Programming in wxLua" in the wxlua.html manual.</li><li>In short, all objects that you create that deal with graphics should be --- 48,52 ---- that return wxArrayStrings or wxSortedArrayStrings will return a wxArrayString or wxSortedArrayString unless specified otherwise in ! wxluaref.html</li></ul><li><h4><a name="wxArrayInt"></a>wxArrayInt?</h4></li><ul><li>All functions that take a wxArrayInt can also take a numerically indexed table of numbers.</li><li>Functions that return wxArrayInts will return a wxArrayInt unless specified otherwise in wxluaref.html.</li></ul><li><h4><a name="When_and_how_should_you_delete_objects"></a>When and how should you delete() objects?</h4></li><ul><li>You should read the section "C++ Classes CLASS_NAME" in the "Programming in wxLua" in the wxlua.html manual.</li><li>In short, all objects that you create that deal with graphics should be *************** *** 58,61 **** the function "table = wxlua.GetTrackedUserdata()" to get a table of items that are tracked and occasionally print them out while developing ! a program. </li></ul></ol><ol><ol> </ol></ol><ul> </ul> </ol></body></html> \ No newline at end of file --- 57,64 ---- the function "table = wxlua.GetTrackedUserdata()" to get a table of items that are tracked and occasionally print them out while developing ! a program.</li></ul><li><h4><a name="Why_do_the_samples_use_the_function"></a>Why do the samples use the function main() is it special to wxLua?</h4></li><ul><li>There's nothing special about the function main() other than that it's a common name for an entry point into a program.</li><li>It ! is often helpful and a good idea to encapsulate the program ! initialization code within a function so that you can use local ! variables and not pollute the global table with temporary variables ! that won't be needed again.</li><li>Additionally, it allows you to break out of this initialization code at any point by putting <span style="font-style: italic;">"do return end"</span> inside of the function for debugging, as opposed to wrapping parts you don't want using <span style="font-style: italic;">"if false then ... end"</span>.</li></ul></ol><ol><ol> </ol></ol><ul> </ul> </ol></body></html> \ No newline at end of file |