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/LuaElementConvertor.h | |
| 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/LuaElementConvertor.h')
| -rw-r--r-- | Sluift/LuaElementConvertor.h | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/Sluift/LuaElementConvertor.h b/Sluift/LuaElementConvertor.h index 187ccf1..42bb69f 100644 --- a/Sluift/LuaElementConvertor.h +++ b/Sluift/LuaElementConvertor.h @@ -20,9 +20,20 @@ namespace Swift { public: static boost::optional<std::string> NO_RESULT; + struct Documentation { + Documentation(const std::string& className, const std::string& description) : + className(className), description(description) {} + std::string className; + std::string description; + }; + virtual ~LuaElementConvertor(); virtual boost::shared_ptr<Payload> convertFromLua(lua_State*, int index, const std::string& type) = 0; virtual boost::optional<std::string> convertToLua(lua_State*, boost::shared_ptr<Payload>) = 0; + + virtual boost::optional<Documentation> getDocumentation() const { + return boost::optional<Documentation>(); + } }; } |