[4/4] incubator-mynewt-core git commit: eventq - Add some comments.

[cc...@apache.org]

eventq - Add some comments.


Project: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-core/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-core/commit/7ad9747d
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-core/tree/7ad9747d
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-core/diff/7ad9747d

Branch: refs/heads/develop
Commit: 7ad9747dacde6c8a07305edf8ea04c7db8178f92
Parents: 83129d4
Author: Christopher Collins <cc...@apache.org>
Authored: Wed Nov 9 10:22:26 2016 -0800
Committer: Christopher Collins <cc...@apache.org>
Committed: Wed Nov 9 14:45:49 2016 -0800

----------------------------------------------------------------------
 kernel/os/src/os_eventq.c | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-mynewt-core/blob/7ad9747d/kernel/os/src/os_eventq.c
----------------------------------------------------------------------
diff --git a/kernel/os/src/os_eventq.c b/kernel/os/src/os_eventq.c
index 3d79533..5c020c0 100644
--- a/kernel/os/src/os_eventq.c
+++ b/kernel/os/src/os_eventq.c
@@ -260,12 +260,26 @@ os_eventq_remove(struct os_eventq *evq, struct os_event *ev)
     OS_EXIT_CRITICAL(sr);
 }
 
+/**
+ * Assigns the default event queue.  Packages which require an event queue, and
+ * which haven't been explicitly told which one to use, will use this one
+ * automatically.
+ *
+ * @param evq                   The event queue to designate as the default.
+ */
 void
 os_eventq_dflt_set(struct os_eventq *evq)
 {
     os_eventq_main = evq;
 }
 
+/**
+ * Retrieves the default event queue, if any.  The default event queue is
+ * designated via a call to os_eventq_dflt_set().  
+ *
+ * @return                      The default event queue, no NULL if there isn't
+ *                                  any.
+ */
 struct os_eventq *
 os_eventq_dflt_get(void)
 {