diff options
author | Erik Schilling <ablu.erikschilling@googlemail.com> | 2013-02-20 17:21:18 +0100 |
---|---|---|
committer | Erik Schilling <ablu.erikschilling@googlemail.com> | 2013-02-24 20:31:20 +0100 |
commit | 30a62acef45fb1652d0992dcbf30e473cea6bf74 (patch) | |
tree | b6a024b7c7051db65429332d986e0d2e7322a9f7 /example | |
parent | f46037b4b32356e94cf8564bc9486b1b13d2dbda (diff) | |
download | manaserv-30a62acef45fb1652d0992dcbf30e473cea6bf74.tar.gz manaserv-30a62acef45fb1652d0992dcbf30e473cea6bf74.tar.bz2 manaserv-30a62acef45fb1652d0992dcbf30e473cea6bf74.tar.xz manaserv-30a62acef45fb1652d0992dcbf30e473cea6bf74.zip |
Documented all lua binds directly in the source
This change adds a comment to each lua binding. In the future a script should
parse those and generate the docs from them.
This should prevent outdated docs and duplicate effort to keep code and docs
synced.
In C++ categories can be defined in this way:
/** LUA_CATEGORY long description of the category (shortname)
* further text
* goes into
* the next lines
*/
The shortname is only used to bind other comments to the category.
In lua the category would look like this:
--- LUA_CATEGORY long description of the category (shortname)
-- further text
-- goes into
-- the next lines
A comment that describes a bind then can look like this:
/** LUA some_function (shortnameofcategory)
* some_function(string name)
* some_function(int id)
**
* Description
*/
Or in Lua:
--- LUA some_function (shortnameofcategory)
-- some_function(string name)
-- some_function(int id)
---
-- Description
Autoupdates script follows soon
Diffstat (limited to 'example')
0 files changed, 0 insertions, 0 deletions