aboutsummaryrefslogtreecommitdiff
path: root/src/lib/version
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2019-10-26 11:13:29 -0400
committerNick Mathewson <nickm@torproject.org>2019-10-26 11:13:29 -0400
commit39d09ea0810f74a7666d9d694903780a14b48ca2 (patch)
treee001b17f1d896520a21bf0a21e4b44433c5d5e6a /src/lib/version
parente7993dc046a099075bc5f9f65a7bb1601686d03c (diff)
downloadtor-39d09ea0810f74a7666d9d694903780a14b48ca2.tar.gz
tor-39d09ea0810f74a7666d9d694903780a14b48ca2.zip
doxygen: add @file declarations for src/lib
If a file doesn't use the file command (either \file or @file), Doxygen won't try to process it. These declarations also turned up a doxygen warning for crypto_ope.c; I fixed that too.
Diffstat (limited to 'src/lib/version')
-rw-r--r--src/lib/version/git_revision.c5
-rw-r--r--src/lib/version/git_revision.h5
-rw-r--r--src/lib/version/torversion.h5
-rw-r--r--src/lib/version/version.c5
4 files changed, 20 insertions, 0 deletions
diff --git a/src/lib/version/git_revision.c b/src/lib/version/git_revision.c
index 6cfb3b4ec0..e87620a20c 100644
--- a/src/lib/version/git_revision.c
+++ b/src/lib/version/git_revision.c
@@ -6,6 +6,11 @@
#include "orconfig.h"
#include "lib/version/git_revision.h"
+/**
+ * @file git_revision.c
+ * @brief Strings to describe the current Git commit.
+ **/
+
/** String describing which Tor Git repository version the source was
* built from. This string is generated by a bit of shell kludging in
* src/core/include.am, and is usually right.
diff --git a/src/lib/version/git_revision.h b/src/lib/version/git_revision.h
index 79e3c6684b..5d08e84b84 100644
--- a/src/lib/version/git_revision.h
+++ b/src/lib/version/git_revision.h
@@ -6,6 +6,11 @@
#ifndef TOR_GIT_REVISION_H
#define TOR_GIT_REVISION_H
+/**
+ * @file git_revision.h
+ * @brief Header for git_revision.c
+ **/
+
extern const char tor_git_revision[];
extern const char tor_bug_suffix[];
diff --git a/src/lib/version/torversion.h b/src/lib/version/torversion.h
index 7b0fb66ec0..50d646bd23 100644
--- a/src/lib/version/torversion.h
+++ b/src/lib/version/torversion.h
@@ -6,6 +6,11 @@
#ifndef TOR_VERSION_H
#define TOR_VERSION_H
+/**
+ * @file torversion.h
+ * @brief Header for version.c.
+ **/
+
const char *get_version(void);
const char *get_short_version(void);
diff --git a/src/lib/version/version.c b/src/lib/version/version.c
index 434e6fb424..b2f25e97b5 100644
--- a/src/lib/version/version.c
+++ b/src/lib/version/version.c
@@ -10,6 +10,11 @@
#include <stdio.h>
#include <string.h>
+/**
+ * @file version.c
+ * @brief Functions to get the version of Tor.
+ **/
+
/** A shorter version of this Tor process's version, for export in our router
* descriptor. (Does not include the git version, if any.) */
static const char the_short_tor_version[] =