#endif
#include <event2/util.h>
-struct evbuffer;
+/**
+ An evbuffer is an opaque data type for efficiently buffering data to be
+ sent or received on the network.
+
+ @see event2/event.h for more information
+*/
+struct evbuffer
+#ifdef _EVENT_IN_DOXYGEN
+{}
+#endif
+;
+
+/**
+ Pointer to a position within an evbuffer.
+
+ Used when repeatedly searching through a buffer. Calling any function
+ that modifies or re-packs the buffer contents may invalidate all
+ evbuffer_ptrs for that buffer. Do not modify these values except with
+ evbuffer_ptr_set.
+
-/** Points to a position within an evbuffer. Used when repeatedly searching
- through a buffer. Calls to any function that modifies or re-packs the
- buffer contents may invalidate all evbuffer_ptrs for that buffer. Do not
- modify these values except with evbuffer_ptr_set.
++ Used when repeatedly searching through a buffer. Calls to any function
++ that modifies or re-packs the buffer contents may invalidate all
++ evbuffer_ptrs for that buffer. Do not modify these values except with
++ evbuffer_ptr_set.
+
+ An evbuffer_ptr can represent any position from the start of a buffer up
+ to a position immediately after the end of a buffer.
++
++ @see evbuffer_ptr_set()
*/
struct evbuffer_ptr {
ev_ssize_t pos;
@param outbuf the output buffer
@param fd the file descriptor
- <<<<<<< HEAD
-- @param off the offset from which to read data
++ @param offset the offset from which to read data
@param length how much data to read, or -1 to read as much as possible.
(-1 requires that 'fd' support fstat.)
- ||||||| merged common ancestors
- @param off the offset from which to read data
- @param length how much data to read
- =======
- @param offset the offset from which to read data
- @param length how much data to read
- >>>>>>> origin/patches-2.0
@return 0 if successful, or -1 if an error occurred
*/