Swiftdiff options
| author | Remko Tronçon <git@el-tramo.be> | 2013-12-30 11:21:45 (GMT) |
|---|---|---|
| committer | Remko Tronçon <git@el-tramo.be> | 2014-01-03 11:09:06 (GMT) |
| commit | 26bb5aa9e2f520c3c943797e6143c32e5b16806b (patch) | |
| tree | 0caa41938acf53da946847f8803c62e579525af9 /Sluift/ElementConvertors | |
| parent | 0b19dc7292b7672c9fbb711a411c392bc5b2bb34 (diff) | |
| download | swift-26bb5aa9e2f520c3c943797e6143c32e5b16806b.zip swift-26bb5aa9e2f520c3c943797e6143c32e5b16806b.tar.bz2 | |
Sluift: Add help support
Provide a 'help' function that takes a table/function, and prints help
for it. A structured representation can be retrieved through 'get_help'.
Change-Id: I2b3ce8992943ef30cee2604fba9200feed263fa5
Diffstat (limited to 'Sluift/ElementConvertors')
| -rw-r--r-- | Sluift/ElementConvertors/DiscoInfoConvertor.cpp | 15 | ||||
| -rw-r--r-- | Sluift/ElementConvertors/DiscoInfoConvertor.h | 1 |
2 files changed, 16 insertions, 0 deletions
diff --git a/Sluift/ElementConvertors/DiscoInfoConvertor.cpp b/Sluift/ElementConvertors/DiscoInfoConvertor.cpp index ac0cf2e..b4bd2e1 100644 --- a/Sluift/ElementConvertors/DiscoInfoConvertor.cpp +++ b/Sluift/ElementConvertors/DiscoInfoConvertor.cpp @@ -99,3 +99,18 @@ void DiscoInfoConvertor::doConvertToLua(lua_State* L, boost::shared_ptr<DiscoInf // TODO: Extension } + +boost::optional<LuaElementConvertor::Documentation> DiscoInfoConvertor::getDocumentation() const { + return Documentation( + "DiscoInfo", + "Represents `disco#info` service discovery data.\n\n" + "This table has the following structure:\n\n" + "- `node`: string\n" + "- `identities`: array(table)\n" + " - `name`: string\n" + " - `category`: string\n" + " - `type`: string\n" + " - `language`: string\n" + "- `features`: array(string)\n" + ); +} diff --git a/Sluift/ElementConvertors/DiscoInfoConvertor.h b/Sluift/ElementConvertors/DiscoInfoConvertor.h index 7a2270e..4cf9c71 100644 --- a/Sluift/ElementConvertors/DiscoInfoConvertor.h +++ b/Sluift/ElementConvertors/DiscoInfoConvertor.h @@ -19,5 +19,6 @@ namespace Swift { virtual boost::shared_ptr<DiscoInfo> doConvertFromLua(lua_State*) SWIFTEN_OVERRIDE; virtual void doConvertToLua(lua_State*, boost::shared_ptr<DiscoInfo>) SWIFTEN_OVERRIDE; + virtual boost::optional<Documentation> getDocumentation() const SWIFTEN_OVERRIDE; }; } |