diff options
author | Nick Mathewson <nickm@torproject.org> | 2019-10-26 12:05:28 -0400 |
---|---|---|
committer | Nick Mathewson <nickm@torproject.org> | 2019-10-26 12:05:28 -0400 |
commit | 68f808604187af539128c79b4fb84099b3e17e4f (patch) | |
tree | e26c7c54db32a51099b2040d46ad403d3124f048 /src/feature/dircache | |
parent | 30c6ab5150248019358addba391cd0a90e9614af (diff) | |
download | tor-68f808604187af539128c79b4fb84099b3e17e4f.tar.gz tor-68f808604187af539128c79b4fb84099b3e17e4f.zip |
doxygen: add @file declarations for src/feature/
If a file doesn't use the file command (either \file or @file),
Doxygen won't try to process it.
Diffstat (limited to 'src/feature/dircache')
-rw-r--r-- | src/feature/dircache/cached_dir_st.h | 6 | ||||
-rw-r--r-- | src/feature/dircache/conscache.c | 5 | ||||
-rw-r--r-- | src/feature/dircache/conscache.h | 5 | ||||
-rw-r--r-- | src/feature/dircache/consdiffmgr.h | 5 | ||||
-rw-r--r-- | src/feature/dircache/dircache.c | 5 |
5 files changed, 25 insertions, 1 deletions
diff --git a/src/feature/dircache/cached_dir_st.h b/src/feature/dircache/cached_dir_st.h index a28802f905..e086f5b11d 100644 --- a/src/feature/dircache/cached_dir_st.h +++ b/src/feature/dircache/cached_dir_st.h @@ -4,6 +4,11 @@ * Copyright (c) 2007-2019, The Tor Project, Inc. */ /* See LICENSE for licensing information */ +/** + * @file cached_dir_st.h + * @brief Cached large directory object structure. + **/ + #ifndef CACHED_DIR_ST_H #define CACHED_DIR_ST_H @@ -22,4 +27,3 @@ struct cached_dir_t { }; #endif /* !defined(CACHED_DIR_ST_H) */ - diff --git a/src/feature/dircache/conscache.c b/src/feature/dircache/conscache.c index 2ec9981c03..80da52aa1b 100644 --- a/src/feature/dircache/conscache.c +++ b/src/feature/dircache/conscache.c @@ -1,6 +1,11 @@ /* Copyright (c) 2017-2019, The Tor Project, Inc. */ /* See LICENSE for licensing information */ +/** + * @file conscache.c + * @brief Consensus and diff on-disk cache. + **/ + #include "core/or/or.h" #include "app/config/config.h" diff --git a/src/feature/dircache/conscache.h b/src/feature/dircache/conscache.h index d848e57617..54c081c068 100644 --- a/src/feature/dircache/conscache.h +++ b/src/feature/dircache/conscache.h @@ -1,6 +1,11 @@ /* Copyright (c) 2017-2019, The Tor Project, Inc. */ /* See LICENSE for licensing information */ +/** + * @file conscache.h + * @brief Header for conscache.c + **/ + #ifndef TOR_CONSCACHE_H #define TOR_CONSCACHE_H diff --git a/src/feature/dircache/consdiffmgr.h b/src/feature/dircache/consdiffmgr.h index b1b3323b6c..7222353650 100644 --- a/src/feature/dircache/consdiffmgr.h +++ b/src/feature/dircache/consdiffmgr.h @@ -1,6 +1,11 @@ /* Copyright (c) 2017-2019, The Tor Project, Inc. */ /* See LICENSE for licensing information */ +/** + * @file consdiffmgr.h + * @brief Header for consdiffmgr.c + **/ + #ifndef TOR_CONSDIFFMGR_H #define TOR_CONSDIFFMGR_H diff --git a/src/feature/dircache/dircache.c b/src/feature/dircache/dircache.c index d4d0ad9939..91d5a7e487 100644 --- a/src/feature/dircache/dircache.c +++ b/src/feature/dircache/dircache.c @@ -3,6 +3,11 @@ * Copyright (c) 2007-2019, The Tor Project, Inc. */ /* See LICENSE for licensing information */ +/** + * @file dircache.c + * @brief Cache directories and serve them to clients. + **/ + #define DIRCACHE_PRIVATE #include "core/or/or.h" |