[tor-commits] [stegotorus/master] Fix some old comments.

[zwol at torproject.org]

commit 15da94646e4d0bc9fd22458df98c23fc7cbd457d
Author: Zack Weinberg <zackw at cmu.edu>
Date:   Mon Feb 27 16:49:42 2012 -0800

    Fix some old comments.
---
 src/protocol.h |   13 ++++---------
 src/steg.h     |    7 +++----
 2 files changed, 7 insertions(+), 13 deletions(-)

diff --git a/src/protocol.h b/src/protocol.h
index 98ad39c..9643b1a 100644
--- a/src/protocol.h
+++ b/src/protocol.h
@@ -68,17 +68,12 @@ struct config_t
 int config_is_supported(const char *name);
 config_t *config_create(int n_options, const char *const *options);
 
-/**
-   This struct defines a protocol and its methods; note that not all
-   of them are methods on the same object in the C++ sense.
-   See connections.h for the definitions of 'conn_t' and 'circuit_t'.
-
-   A filled-in, statically allocated proto_module object is the
-   principal interface between each individual protocol and generic code.
- */
+/** PROTO_DEFINE_MODULE defines an object with this type, plus the
+    function that it points to; there is a table of all such objects,
+    which generic code uses to know what protocols are available. */
 struct proto_module
 {
-  /** The short name of this protocol. Must be a valid C identifier. */
+  /** Name of this protocol. Must be a valid C identifier. */
   const char *name;
 
   /** Create a config_t instance for this module from a set of command
diff --git a/src/steg.h b/src/steg.h
index 63f0fc9..dab44e5 100644
--- a/src/steg.h
+++ b/src/steg.h
@@ -44,10 +44,9 @@ struct steg_t
 };
 
 /** STEG_DEFINE_MODULE defines an object with this type, plus the
-    function that it points to.  You don't ever manipulate this object
-    directly; however, read its documentation to understand the
-    arguments to STEG_DEFINE_MODULE. */
-
+    function that it points to; there is a table of all such objects,
+    which generic code uses to know what steganography modules are
+    available. */
 struct steg_module
 {
   /** Name of the steganography module. Must be a valid C identifier. */