Swiftdiff 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/PubSubItemsConvertor.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/PubSubItemsConvertor.cpp')
| -rw-r--r-- | Sluift/ElementConvertors/PubSubItemsConvertor.cpp | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/Sluift/ElementConvertors/PubSubItemsConvertor.cpp b/Sluift/ElementConvertors/PubSubItemsConvertor.cpp index 5ecb72e..24ad6c8 100644 --- a/Sluift/ElementConvertors/PubSubItemsConvertor.cpp +++ b/Sluift/ElementConvertors/PubSubItemsConvertor.cpp @@ -84,3 +84,14 @@ void PubSubItemsConvertor::doConvertToLua(lua_State* L, boost::shared_ptr<PubSub lua_setfield(L, -2, "subscriptionid"); } } + +boost::optional<LuaElementConvertor::Documentation> PubSubItemsConvertor::getDocumentation() const { + return Documentation( + "PubSubItems", + "This table has the following fields:\n\n" + "- `node`: string\n" + "- `items`: array<@{PubSubItem}>\n" + "- `maximum_items`: number (Optional)\n" + "- `subscriptionid`: string (Optional)\n" + ); +} |