diff options
author | Remko Tronçon <git@el-tramo.be> | 2014-01-02 09:27:31 (GMT) |
---|---|---|
committer | Remko Tronçon <git@el-tramo.be> | 2014-01-03 11:09:06 (GMT) |
commit | 9d787c6337d7080cb32af800a96cf64d43373514 (patch) | |
tree | 6ec7c622e0545ef22bf31c0c95f0476f8d2aacce /Sluift/ElementConvertors/PubSubEventItemConvertor.cpp | |
parent | 26bb5aa9e2f520c3c943797e6143c32e5b16806b (diff) | |
download | swift-9d787c6337d7080cb32af800a96cf64d43373514.zip swift-9d787c6337d7080cb32af800a96cf64d43373514.tar.bz2 |
Sluift: Document some more elements
Change-Id: I2a755500f0fe88bbea5594ce858bc92dccc34805
Diffstat (limited to 'Sluift/ElementConvertors/PubSubEventItemConvertor.cpp')
-rw-r--r-- | Sluift/ElementConvertors/PubSubEventItemConvertor.cpp | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/Sluift/ElementConvertors/PubSubEventItemConvertor.cpp b/Sluift/ElementConvertors/PubSubEventItemConvertor.cpp index fab4bff..1e66b40 100644 --- a/Sluift/ElementConvertors/PubSubEventItemConvertor.cpp +++ b/Sluift/ElementConvertors/PubSubEventItemConvertor.cpp @@ -90,3 +90,14 @@ void PubSubEventItemConvertor::doConvertToLua(lua_State* L, boost::shared_ptr<Pu lua_setfield(L, -2, "id"); } } + +boost::optional<LuaElementConvertor::Documentation> PubSubEventItemConvertor::getDocumentation() const { + return Documentation( + "PubSubEventItem", + "This table has the following fields:\n\n" + "- `node`: string (Optional)\n" + "- `publisher`: string (Optional)\n" + "- `data`: array<element (table)>\n" + "- `id`: string (Optional)\n" + ); +} |