From: Nick Mathewson <nickm@torproject.org>
Date: Mon, 2 Nov 2009 16:31:13 +0000 (+0000)
Subject: Call the bufferevent_flush_mode variable "mode" more consistently in the documentatio... 
X-Git-Tag: release-2.0.3-alpha~59
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=e90e14fb94f7bb54f822dd5d3bfbf476649451e5;p=libevent

Call the bufferevent_flush_mode variable "mode" more consistently in the documentation. Spotted by Alex.

svn:r1485
---

diff --git a/include/event2/bufferevent.h b/include/event2/bufferevent.h
index dd311853..3123a409 100644
--- a/include/event2/bufferevent.h
+++ b/include/event2/bufferevent.h
@@ -386,12 +386,12 @@ enum bufferevent_flush_mode {
 
    @param bufev the bufferevent object
    @param iotype either EV_READ or EV_WRITE or both.
-   @param state either BEV_NORMAL or BEV_FLUSH or BEV_FINISHED
+   @param mode either BEV_NORMAL or BEV_FLUSH or BEV_FINISHED
    @return -1 on failure, 0 if no data was produces, 1 if data was produced
  */
 int bufferevent_flush(struct bufferevent *bufev,
     short iotype,
-    enum bufferevent_flush_mode state);
+    enum bufferevent_flush_mode mode);
 
 /**
    Support for filtering input and output of bufferevents.
@@ -420,7 +420,7 @@ enum bufferevent_filter_result {
        The filter may ignore this value, but doing so means that
        it will overflow the high-water mark associated with dst.
        -1 means "no limit".
-    @param state Whether we should write data as may be convenient
+    @param mode Whether we should write data as may be convenient
        (BEV_NORMAL), or flush as much data as we can (BEV_FLUSH),
        or flush as much as we can, possibly including an end-of-stream
        marker (BEV_FINISH).