Add commenting

open-telemetry · Jul 7, 2020 · 8f358c9 · 8f358c9
1 parent 3212ed4
commit 8f358c9
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/sdk/src/event/libevent/io_dispatcher.h b/sdk/src/event/libevent/io_dispatcher.h
@@ -12,6 +12,13 @@ namespace event
 {
 namespace libevent
 {
+/**
+ * Manages asynchronous events on a file descriptor.
+ *
+ * IoDispatcher enables an efficient design where SDKs use non-blocking sockets and a single
+ * background thread manages events by making successive calls to the OS's IO multiplexing polling
+ * function.
+ */
 class IoDispatcher final : public event::IoDispatcher
 {
 public: