diff options
author | Nick Mathewson <nickm@torproject.org> | 2018-07-01 20:22:55 -0400 |
---|---|---|
committer | Nick Mathewson <nickm@torproject.org> | 2018-07-01 20:22:55 -0400 |
commit | cb1a3674ebb3826d9e1e56146210bd79cb4a42f0 (patch) | |
tree | 84382a222e7d271efb8426560b61fb1a28ec4e05 /src/lib/container/smartlist.c | |
parent | 83a4946e7b9d2bb75ab8dfa8073c5dd7b3f77bc9 (diff) | |
download | tor-cb1a3674ebb3826d9e1e56146210bd79cb4a42f0.tar.gz tor-cb1a3674ebb3826d9e1e56146210bd79cb4a42f0.zip |
File-level documentation for some of src/lib.
Diffstat (limited to 'src/lib/container/smartlist.c')
-rw-r--r-- | src/lib/container/smartlist.c | 12 |
1 files changed, 9 insertions, 3 deletions
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" |