diff options
author | Hadriel Kaplan <hadrielk@yahoo.com> | 2015-07-07 11:30:44 -0400 |
---|---|---|
committer | Hadriel Kaplan <hadrielk@yahoo.com> | 2015-07-12 02:08:24 +0000 |
commit | 0caf0616ba53282cf4ef5587e13989a7aacc9588 (patch) | |
tree | 298c5cb80751accd9076a6da6c2cd89ac31e9d87 /doc | |
parent | ec1e099dc0b1a1307df1c7f002905e7d38a5f2c7 (diff) |
Lua: split up wslua files into class-based files
The size of some of the wslua source files has grown large, and it's hard
to quickly find things. So split them up based on class name, as much as
seems reasonable. Also have the make-wsluarm.pl Perl script handle this.
Change-Id: Ib495ec5c2a4df90495c0a05504856288a0b09213
Reviewed-on: https://code.wireshark.org/review/9579
Petri-Dish: Hadriel Kaplan <hadrielk@yahoo.com>
Tested-by: Petri Dish Buildbot <buildbot-no-reply@wireshark.org>
Reviewed-by: Hadriel Kaplan <hadrielk@yahoo.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/README.wslua | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/README.wslua b/doc/README.wslua index 5bee84b090..74074904e3 100644 --- a/doc/README.wslua +++ b/doc/README.wslua @@ -289,6 +289,14 @@ to make new wslua files generate documentation, it is not sufficient to just add this macro to a new file and add the file to the CMakeLists.txt; you also have to add the module name into docbook/user-guide.xml, and docbook/wsluarm.xml. + +WSLUA_CONTINUE_MODULE - like WSLUA_MODULE, except used at the top of a .c file +to continue defining classes/functions/etc. within a previously declared module +in a previous file (i.e., one that used WSLUA_MODULE). The module name must match +the original one, and the .c file must be listed after the original one in the +CMakeLists.txt/Makefile.common lists in the docbook directory. + + WSLUA_ATTRIBUTE - this is another documentation-only "macro", only used within comments. It makes the API docs generate documentation for a member variable of a class, i.e. a key of a Lua table that is not called as a function in Lua, @@ -327,6 +335,7 @@ Example: WSLUA_RETURN(1); /* A boolean: true if it is enabled, false if it isn't. */ } + WSLUA_CLASS_DEFINE - this is used to define/create a new Lua class type (i.e., table with methods). A Class name must begin with an uppercase letter, followed by any upper or lower case letters but not underscores; in other @@ -338,6 +347,7 @@ Example: WSLUA_CLASS_DEFINE(ProgDlg,NOP,NOP); /* Manages a progress bar dialog. */ + WSLUA_CONSTRUCTOR - this is used to define a function of a class that is a static function rather than a per-object method; i.e., from a Lua perspective the function is called as 'myObj.func()' instead of 'myObj:func()'. From a |