aboutsummaryrefslogtreecommitdiff
path: root/src/common/container.h
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2007-02-02 20:06:43 +0000
committerNick Mathewson <nickm@torproject.org>2007-02-02 20:06:43 +0000
commitfefba953634ef35e2ec83716924c84a375e86ad6 (patch)
tree58f786243ef3553a70dedc8f34db668764071099 /src/common/container.h
parente521c96cb191ae746e06304b6bba49d925f63469 (diff)
downloadtor-fefba953634ef35e2ec83716924c84a375e86ad6.tar.gz
tor-fefba953634ef35e2ec83716924c84a375e86ad6.zip
r11629@catbus: nickm | 2007-02-02 15:06:17 -0500
Removing the last DOCDOC comment hurt so much that I had to use Doxygen to identify undocumented macros and comments, and add 150 more DOCDOCs to point out where they were. Oops. Hey, kids! Fixing some of these could be your first Tor patch! svn:r9477
Diffstat (limited to 'src/common/container.h')
-rw-r--r--src/common/container.h7
1 files changed, 6 insertions, 1 deletions
diff --git a/src/common/container.h b/src/common/container.h
index a6b7b56adb..8fbc863cbb 100644
--- a/src/common/container.h
+++ b/src/common/container.h
@@ -11,7 +11,12 @@
#include "compat.h"
#include "util.h"
-/** A resizeable list of pointers, with associated helpful functionality. */
+/** A resizeable list of pointers, with associated helpful functionality.
+ *
+ * The members of this struct are exposed only so that macros and inlines can
+ * use them; all access to smartlist internals should go throuch the functions
+ * and macros defined here.
+ **/
typedef struct smartlist_t {
/** <b>list</b> has enough capacity to store exactly <b>capacity</b> elements
* before it needs to be resized. Only the first <b>num_used</b> (\<=