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/PubSubEventSubscriptionConvertor.cpp
parent26bb5aa9e2f520c3c943797e6143c32e5b16806b (diff)
downloadswift-9d787c6337d7080cb32af800a96cf64d43373514.zip
swift-9d787c6337d7080cb32af800a96cf64d43373514.tar.bz2
Sluift: Document some more elements
Change-Id: I2a755500f0fe88bbea5594ce858bc92dccc34805
Diffstat (limited to 'Sluift/ElementConvertors/PubSubEventSubscriptionConvertor.cpp')
-rw-r--r--Sluift/ElementConvertors/PubSubEventSubscriptionConvertor.cpp12
1 files changed, 12 insertions, 0 deletions
diff --git a/Sluift/ElementConvertors/PubSubEventSubscriptionConvertor.cpp b/Sluift/ElementConvertors/PubSubEventSubscriptionConvertor.cpp
index a4c160f..463ebea 100644
--- a/Sluift/ElementConvertors/PubSubEventSubscriptionConvertor.cpp
+++ b/Sluift/ElementConvertors/PubSubEventSubscriptionConvertor.cpp
@@ -93,3 +93,15 @@ void PubSubEventSubscriptionConvertor::doConvertToLua(lua_State* L, boost::share
lua_pushstring(L, dateTimeToString(payload->getExpiry()).c_str());
lua_setfield(L, -2, "expiry");
}
+
+boost::optional<LuaElementConvertor::Documentation> PubSubEventSubscriptionConvertor::getDocumentation() const {
+ return Documentation(
+ "PubSubEventSubscription",
+ "This table has the following fields:\n\n"
+ "- `node`: string\n"
+ "- `jid`: jid (string)\n"
+ "- `subscription`: `\"none\"`, `\"pending\"`, `\"subscribed\"`, or `\"unconfigured\"`\n"
+ "- `subscriptionid`: string (Optional)\n"
+ "- `expiry`: datetime (string)\n"
+ );
+}