summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRemko Tronçon <git@el-tramo.be>2014-01-02 09:27:31 (GMT)
committerRemko Tronçon <git@el-tramo.be>2014-01-03 11:09:06 (GMT)
commit9d787c6337d7080cb32af800a96cf64d43373514 (patch)
tree6ec7c622e0545ef22bf31c0c95f0476f8d2aacce /Sluift/ElementConvertors/PubSubDefaultConvertor.cpp
parent26bb5aa9e2f520c3c943797e6143c32e5b16806b (diff)
downloadswift-9d787c6337d7080cb32af800a96cf64d43373514.zip
swift-9d787c6337d7080cb32af800a96cf64d43373514.tar.bz2
Sluift: Document some more elements
Change-Id: I2a755500f0fe88bbea5594ce858bc92dccc34805
Diffstat (limited to 'Sluift/ElementConvertors/PubSubDefaultConvertor.cpp')
-rw-r--r--Sluift/ElementConvertors/PubSubDefaultConvertor.cpp9
1 files changed, 9 insertions, 0 deletions
diff --git a/Sluift/ElementConvertors/PubSubDefaultConvertor.cpp b/Sluift/ElementConvertors/PubSubDefaultConvertor.cpp
index d9b68ac..de8e857 100644
--- a/Sluift/ElementConvertors/PubSubDefaultConvertor.cpp
+++ b/Sluift/ElementConvertors/PubSubDefaultConvertor.cpp
@@ -66,3 +66,12 @@ void PubSubDefaultConvertor::doConvertToLua(lua_State* L, boost::shared_ptr<PubS
}
lua_setfield(L, -2, "type");
}
+
+boost::optional<LuaElementConvertor::Documentation> PubSubDefaultConvertor::getDocumentation() const {
+ return Documentation(
+ "PubSubDefault",
+ "This table has the following fields:\n\n"
+ "- `node`: string (Optional)\n"
+ "- `type`: `\"none\"`, `\"collection\"`, or `\"leaf\"`\n"
+ );
+}