From 39d09ea0810f74a7666d9d694903780a14b48ca2 Mon Sep 17 00:00:00 2001
From: Nick Mathewson <nickm@torproject.org>
Date: Sat, 26 Oct 2019 11:13:29 -0400
Subject: 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.
---
 src/lib/version/git_revision.c | 5 +++++
 src/lib/version/git_revision.h | 5 +++++
 src/lib/version/torversion.h   | 5 +++++
 src/lib/version/version.c      | 5 +++++
 4 files changed, 20 insertions(+)

(limited to 'src/lib/version')

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[] =
-- 
cgit v1.2.3-54-g00ecf