aboutsummaryrefslogtreecommitdiffstats
path: root/doc/api.mdwn
diff options
context:
space:
mode:
authorThomas Harning Jr <harningt@gmail.com>2007-11-16 11:22:01 -0500
committerThomas Harning Jr <harningt@gmail.com>2007-11-16 11:22:01 -0500
commit73478948f9950cdca67f6ac57069bdd74ec94762 (patch)
treebcfc0703c4a760b9975872b5a0ff13e164b944cf /doc/api.mdwn
parentcc2f827db29caa6cc2679909ce5d50129782a900 (diff)
downloadluaevent-prosody-73478948f9950cdca67f6ac57069bdd74ec94762.tar.gz
luaevent-prosody-73478948f9950cdca67f6ac57069bdd74ec94762.zip
Added initial shot at documentation using Ikiwiki (only luaevent.core.buffer is really doc'ed yet)
Diffstat (limited to 'doc/api.mdwn')
-rw-r--r--doc/api.mdwn9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/api.mdwn b/doc/api.mdwn
new file mode 100644
index 0000000..aa528d4
--- /dev/null
+++ b/doc/api.mdwn
@@ -0,0 +1,9 @@
+LuaEvent API Documentation
+----
+
+Modules:
+
+* [[modules/luaevent.core]] - Interface to core libevent functions
+ * [[modules/luaevent.core.buffer]] - Interface to libevent's evbuffer
+ * [[modules/luaevent.core.bufferevent]] - Interface to libevent's bufferevent
+* [[modules/luaevent]] - Higher level wrapper mimicking [copas](http://www.luaforge.net/projects/copas)