aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/api.mdwn1
-rw-r--r--doc/modules/luaevent.core.buffer.mdwn6
2 files changed, 4 insertions, 3 deletions
diff --git a/doc/api.mdwn b/doc/api.mdwn
index 85d572a..983df1b 100644
--- a/doc/api.mdwn
+++ b/doc/api.mdwn
@@ -9,6 +9,7 @@ Modules:
* [[modules/luaevent]] - Higher level wrapper mimicking [copas](http://www.luaforge.net/projects/copas)
Note: Any reference to a "File Descriptor" may in fact be one of the following:
+
* Integer value of file descriptor
* lightuserdata 'handle' (cast to a native integer)
* [LuaSocket](http://www.luaforge.net/projects/luasocket)-based socket handle \ No newline at end of file
diff --git a/doc/modules/luaevent.core.buffer.mdwn b/doc/modules/luaevent.core.buffer.mdwn
index e2782a7..3ae8579 100644
--- a/doc/modules/luaevent.core.buffer.mdwn
+++ b/doc/modules/luaevent.core.buffer.mdwn
@@ -14,10 +14,10 @@ Functions:
* Output: Amount of data added
(QUESTION: Should add return the buffer itself so that chaining can be easy)
-## buffer:length (`__len`)
+## buffer:length (__len)
* Output: Length of the remaining buffer contents
-## buffer:get\_data (`__tostring`)
+## buffer:get\_data (__tostring)
* Input:
* `()` and `__tostring` - Returns all data in the buffer
* `(len)` - Returns data up to `len` bytes long
@@ -56,5 +56,5 @@ potential later data would contain the paired '\n' or '\r'. (TODO: Ask libevent
TODO: Add code to check this condition explicitly for safety
* If `amt >= 0`, drain up to amt from the buffer (no problem w/ too-large values)
-## buffer:close (`__gc`)
+## buffer:close (__gc)
* Immediately frees/closes a buffer. Note that