summaryrefslogtreecommitdiff
path: root/src/feature/dirclient
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2019-10-26 12:05:28 -0400
committerNick Mathewson <nickm@torproject.org>2019-10-26 12:05:28 -0400
commit68f808604187af539128c79b4fb84099b3e17e4f (patch)
treee26c7c54db32a51099b2040d46ad403d3124f048 /src/feature/dirclient
parent30c6ab5150248019358addba391cd0a90e9614af (diff)
downloadtor-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/dirclient')
-rw-r--r--src/feature/dirclient/dir_server_st.h5
-rw-r--r--src/feature/dirclient/dirclient.c5
-rw-r--r--src/feature/dirclient/dlstatus.c5
-rw-r--r--src/feature/dirclient/download_status_st.h6
4 files changed, 20 insertions, 1 deletions
diff --git a/src/feature/dirclient/dir_server_st.h b/src/feature/dirclient/dir_server_st.h
index 8e35532435..69c3856185 100644
--- a/src/feature/dirclient/dir_server_st.h
+++ b/src/feature/dirclient/dir_server_st.h
@@ -4,6 +4,11 @@
* Copyright (c) 2007-2019, The Tor Project, Inc. */
/* See LICENSE for licensing information */
+/**
+ * @file dir_server_st.h
+ * @brief Trusted/fallback directory server structure.
+ **/
+
#ifndef DIR_SERVER_ST_H
#define DIR_SERVER_ST_H
diff --git a/src/feature/dirclient/dirclient.c b/src/feature/dirclient/dirclient.c
index 1ea50fd350..a97b425944 100644
--- a/src/feature/dirclient/dirclient.c
+++ b/src/feature/dirclient/dirclient.c
@@ -3,6 +3,11 @@
* Copyright (c) 2007-2019, The Tor Project, Inc. */
/* See LICENSE for licensing information */
+/**
+ * @file dirclient.c
+ * @brief Download directory information
+ **/
+
#define DIRCLIENT_PRIVATE
#include "core/or/or.h"
diff --git a/src/feature/dirclient/dlstatus.c b/src/feature/dirclient/dlstatus.c
index 0842a2c676..c6fdbebed9 100644
--- a/src/feature/dirclient/dlstatus.c
+++ b/src/feature/dirclient/dlstatus.c
@@ -3,6 +3,11 @@
* Copyright (c) 2007-2019, The Tor Project, Inc. */
/* See LICENSE for licensing information */
+/**
+ * @file dlstatus.c
+ * @brief Track status and retry schedule of a downloadable object.
+ **/
+
#define DLSTATUS_PRIVATE
#include "core/or/or.h"
diff --git a/src/feature/dirclient/download_status_st.h b/src/feature/dirclient/download_status_st.h
index 39a5ad2860..29d0dd5d5f 100644
--- a/src/feature/dirclient/download_status_st.h
+++ b/src/feature/dirclient/download_status_st.h
@@ -4,6 +4,11 @@
* Copyright (c) 2007-2019, The Tor Project, Inc. */
/* See LICENSE for licensing information */
+/**
+ * @file download_status_st.h
+ * @brief Directory download status/schedule structure.
+ **/
+
#ifndef DOWNLOAD_STATUS_ST_H
#define DOWNLOAD_STATUS_ST_H
@@ -62,4 +67,3 @@ struct download_status_t {
};
#endif /* !defined(DOWNLOAD_STATUS_ST_H) */
-