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/meminfo | |
parent | 83a4946e7b9d2bb75ab8dfa8073c5dd7b3f77bc9 (diff) | |
download | tor-cb1a3674ebb3826d9e1e56146210bd79cb4a42f0.tar.gz tor-cb1a3674ebb3826d9e1e56146210bd79cb4a42f0.zip |
File-level documentation for some of src/lib.
Diffstat (limited to 'src/lib/meminfo')
-rw-r--r-- | src/lib/meminfo/meminfo.c | 7 | ||||
-rw-r--r-- | src/lib/meminfo/meminfo.h | 6 |
2 files changed, 13 insertions, 0 deletions
diff --git a/src/lib/meminfo/meminfo.c b/src/lib/meminfo/meminfo.c index 34b4ad3b5d..b5a74ce624 100644 --- a/src/lib/meminfo/meminfo.c +++ b/src/lib/meminfo/meminfo.c @@ -3,6 +3,13 @@ * Copyright (c) 2007-2018, The Tor Project, Inc. */ /* See LICENSE for licensing information */ +/** + * \file meminfo.c + * + * \brief Functions to query total memory, and access meta-information about + * the allocator. + **/ + #include "lib/meminfo/meminfo.h" #include "lib/cc/compat_compiler.h" diff --git a/src/lib/meminfo/meminfo.h b/src/lib/meminfo/meminfo.h index a970e992f0..b67d235559 100644 --- a/src/lib/meminfo/meminfo.h +++ b/src/lib/meminfo/meminfo.h @@ -3,6 +3,12 @@ * Copyright (c) 2007-2018, The Tor Project, Inc. */ /* See LICENSE for licensing information */ +/** + * \file meminfo.h + * + * \brief Header for meminfo.c + **/ + #ifndef TOR_MEMINFO_H #define TOR_MEMINFO_H |