diff options
Diffstat (limited to 'src/lib/container')
-rw-r--r-- | src/lib/container/bitarray.h | 6 | ||||
-rw-r--r-- | src/lib/container/bloomfilt.h | 6 | ||||
-rw-r--r-- | src/lib/container/buffers.c | 4 | ||||
-rw-r--r-- | src/lib/container/buffers.h | 3 | ||||
-rw-r--r-- | src/lib/container/map.c | 5 | ||||
-rw-r--r-- | src/lib/container/map.h | 6 | ||||
-rw-r--r-- | src/lib/container/order.h | 6 | ||||
-rw-r--r-- | src/lib/container/smartlist.c | 12 | ||||
-rw-r--r-- | src/lib/container/smartlist.h | 6 |
9 files changed, 47 insertions, 7 deletions
diff --git a/src/lib/container/bitarray.h b/src/lib/container/bitarray.h index 2cea433fb0..172d56cc06 100644 --- a/src/lib/container/bitarray.h +++ b/src/lib/container/bitarray.h @@ -6,6 +6,12 @@ #ifndef TOR_BITARRAY_H #define TOR_BITARRAY_H +/** + * \file bitarray.h + * + * \brief Implements a variable-sized (but non-resizeable) bit-array. + **/ + #include "orconfig.h" #include <string.h> #include "lib/cc/torint.h" diff --git a/src/lib/container/bloomfilt.h b/src/lib/container/bloomfilt.h index 577acf5e48..14f909cb19 100644 --- a/src/lib/container/bloomfilt.h +++ b/src/lib/container/bloomfilt.h @@ -6,6 +6,12 @@ #ifndef TOR_BLOOMFILT_H #define TOR_BLOOMFILT_H +/** + * \file bloomfilt.h + * + * \brief Header for bloomfilt.c + **/ + #include "orconfig.h" #include "lib/cc/torint.h" #include "lib/container/bitarray.h" diff --git a/src/lib/container/buffers.c b/src/lib/container/buffers.c index 0e98033bfd..5849704e35 100644 --- a/src/lib/container/buffers.c +++ b/src/lib/container/buffers.c @@ -16,6 +16,10 @@ * buffers: one for incoming data, and one for outcoming data. These are fed * and drained from functions in connection.c, trigged by events that are * monitored in main.c. + * + * This module only handles the buffer implementation itself. To use a buffer + * with the network, a compressor, or a TLS connection, see the other buffer_* + * modules. **/ #define BUFFERS_PRIVATE diff --git a/src/lib/container/buffers.h b/src/lib/container/buffers.h index 8b16fb298b..c48f83cfc7 100644 --- a/src/lib/container/buffers.h +++ b/src/lib/container/buffers.h @@ -6,6 +6,7 @@ /** * \file buffers.h + * * \brief Header file for buffers.c. **/ @@ -20,8 +21,6 @@ typedef struct buf_t buf_t; -struct tor_compress_state_t; - buf_t *buf_new(void); buf_t *buf_new_with_capacity(size_t size); size_t buf_get_default_chunk_size(const buf_t *buf); diff --git a/src/lib/container/map.c b/src/lib/container/map.c index 3d84356cc8..0602eac891 100644 --- a/src/lib/container/map.c +++ b/src/lib/container/map.c @@ -4,8 +4,9 @@ /* See LICENSE for licensing information */ /** - * \file container.c - * \brief Hash table implementations of a string-to-void* map, and of + * \file map.c + * + * \brief Hash-table implementations of a string-to-void* map, and of * a digest-to-void* map. **/ diff --git a/src/lib/container/map.h b/src/lib/container/map.h index ac21c28718..ff71622682 100644 --- a/src/lib/container/map.h +++ b/src/lib/container/map.h @@ -6,6 +6,12 @@ #ifndef TOR_MAP_H #define TOR_MAP_H +/** + * \file map.h + * + * \brief Headers for map.c. + **/ + #include "lib/testsupport/testsupport.h" #include "lib/cc/torint.h" diff --git a/src/lib/container/order.h b/src/lib/container/order.h index bd23750d54..f0675f347b 100644 --- a/src/lib/container/order.h +++ b/src/lib/container/order.h @@ -6,6 +6,12 @@ #ifndef TOR_ORDER_H #define TOR_ORDER_H +/** + * \file order.h + * + * \brief Header for order.c. + **/ + #include "lib/cc/compat_compiler.h" #include "lib/cc/torint.h" diff --git a/src/lib/container/smartlist.c b/src/lib/container/smartlist.c index 9025cab9f6..63c50e045d 100644 --- a/src/lib/container/smartlist.c +++ b/src/lib/container/smartlist.c @@ -4,9 +4,15 @@ /* See LICENSE for licensing information */ /** - * \file container.c - * \brief Implements a smartlist (a resizable array) along - * with helper functions to use smartlists. + * \file smartlist.c + * + * \brief Higher-level functions for the "smartlist" resizeable array + * abstraction. + * + * The functions declared here use higher-level functionality than those in + * smartlist_core.c, and handle things like smartlists of different types, + * sorting, searching, heap-structured smartlists, and other convenience + * functions. **/ #include "lib/container/smartlist.h" diff --git a/src/lib/container/smartlist.h b/src/lib/container/smartlist.h index 76ecbda0a2..3b19cbfce4 100644 --- a/src/lib/container/smartlist.h +++ b/src/lib/container/smartlist.h @@ -6,6 +6,12 @@ #ifndef TOR_SMARTLIST_H #define TOR_SMARTLIST_H +/** + * \file smartlist.h + * + * \brief Header for smartlist.c + **/ + #include <stdarg.h> #include "lib/smartlist_core/smartlist_core.h" |