From: Azat Khuzhin <a3at.mail@gmail.com>
Date: Sun, 16 Jul 2017 18:40:18 +0000 (+0300)
Subject: Merge remote-tracking branch 'official/pr/527' -- documentation fixes
X-Git-Tag: release-2.1.9-beta^2~169
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=980394b98b866346f2b625cda7a253421392a090;p=libevent

Merge remote-tracking branch 'official/pr/527' -- documentation fixes

* official/pr/527:
  Fix a few trivial documentation typos
  Clarify event_free() documentation regarding pending/active events

(cherry picked from commit e83443ec67d45447296c2ce320620a07c88e1d32)
---

diff --git a/include/event2/event.h b/include/event2/event.h
index 450bc33c..2ad2ec83 100644
--- a/include/event2/event.h
+++ b/include/event2/event.h
@@ -232,7 +232,7 @@ struct event_base
  *
  * Generally, you can create events with event_new(), then make them
  * pending with event_add().  As your event_base runs, it will run the
- * callbacks of an events whose conditions are triggered.  When you
+ * callbacks of an events whose conditions are triggered.  When you no
  * longer want the event, free it with event_free().
  *
  * In more depth:
@@ -692,7 +692,7 @@ EVENT2_EXPORT_SYMBOL
 void event_base_free(struct event_base *);
 
 /**
-   As event_free, but do not run finalizers.
+   As event_base_free, but do not run finalizers.
 
    THIS IS AN EXPERIMENTAL API. IT MIGHT CHANGE BEFORE THE LIBEVENT 2.1 SERIES
    BECOMES STABLE.
@@ -1124,8 +1124,8 @@ int event_assign(struct event *, struct event_base *, evutil_socket_t, short, ev
 /**
    Deallocate a struct event * returned by event_new().
 
-   If the event is pending or active, first make it non-pending and
-   non-active.
+   If the event is pending or active, this function makes it non-pending
+   and non-active first.
  */
 EVENT2_EXPORT_SYMBOL
 void event_free(struct event *);