tor

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

dispatch_cfg_st.h: make comments into doxygen.

Diffstat:
M
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
@@ -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;