[tor-commits] [tor/master] dispatch_cfg_st.h: make comments into doxygen.

[nickm at torproject.org]

commit 88796637e521c9879f8743a8b6647311a27a9691
Author: Nick Mathewson <nickm at torproject.org>
Date:   Wed Nov 6 13:05:36 2019 -0500

    dispatch_cfg_st.h: make comments into doxygen.
---
 src/lib/dispatch/dispatch_cfg_st.h | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/src/lib/dispatch/dispatch_cfg_st.h b/src/lib/dispatch/dispatch_cfg_st.h
index d06540c4a..f64fc2b32 100644
--- a/src/lib/dispatch/dispatch_cfg_st.h
+++ b/src/lib/dispatch/dispatch_cfg_st.h
@@ -14,8 +14,11 @@
 
 struct smartlist_t;
 
-/* Information needed to create a dispatcher, but in a less efficient, more
- * mutable format. */
+/** Information needed to create a dispatcher, but in a less efficient, more
+ * mutable format.
+ *
+ * Nearly everybody should use the \refdir{lib/pubsub} module to configure
+ * dispatchers, instead of using this. */
 struct dispatch_cfg_t {
   /** A list of msg_type_id_t (cast to void*), indexed by msg_t. */
   struct smartlist_t *type_by_msg;