summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to 'Sluift/ElementConvertors/PubSubAffiliationConvertor.cpp')
-rw-r--r--Sluift/ElementConvertors/PubSubAffiliationConvertor.cpp9
1 files changed, 9 insertions, 0 deletions
diff --git a/Sluift/ElementConvertors/PubSubAffiliationConvertor.cpp b/Sluift/ElementConvertors/PubSubAffiliationConvertor.cpp
index 73d7d6a..c7bd331 100644
--- a/Sluift/ElementConvertors/PubSubAffiliationConvertor.cpp
+++ b/Sluift/ElementConvertors/PubSubAffiliationConvertor.cpp
@@ -82,3 +82,12 @@ void PubSubAffiliationConvertor::doConvertToLua(lua_State* L, boost::shared_ptr<
}
lua_setfield(L, -2, "type");
}
+
+boost::optional<LuaElementConvertor::Documentation> PubSubAffiliationConvertor::getDocumentation() const {
+ return Documentation(
+ "PubSubAffiliation",
+ "This table has the following fields:\n\n"
+ "- `node`: string\n"
+ "- `type`: `\"none\"`, `\"member\"`, `\"outcast\"`, `\"owner\"`, `\"publisher\"`, or `\"publish_only\"`\n"
+ );
+}