aboutsummaryrefslogtreecommitdiff
path: root/src/lib/defs
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2018-07-10 12:22:01 -0400
committerNick Mathewson <nickm@torproject.org>2018-07-10 12:22:01 -0400
commit4f42c923d61655235ebbae82f64106ecff9458d7 (patch)
tree10246207ad5003f7c6ba40a64af0dbb7801af41f /src/lib/defs
parent4793d913503f9349ca4b57d77a47bd1bbceecfe5 (diff)
downloadtor-4f42c923d61655235ebbae82f64106ecff9458d7.tar.gz
tor-4f42c923d61655235ebbae82f64106ecff9458d7.zip
File-level summary documentation for src/lib/*/*.[ch]
Diffstat (limited to 'src/lib/defs')
-rw-r--r--src/lib/defs/dh_sizes.h9
-rw-r--r--src/lib/defs/x25519_sizes.h9
2 files changed, 18 insertions, 0 deletions
diff --git a/src/lib/defs/dh_sizes.h b/src/lib/defs/dh_sizes.h
index b60957281c..a02ffc5281 100644
--- a/src/lib/defs/dh_sizes.h
+++ b/src/lib/defs/dh_sizes.h
@@ -4,6 +4,15 @@
* Copyright (c) 2007-2018, The Tor Project, Inc. */
/* See LICENSE for licensing information */
+/**
+ * \file dh_sizes.h
+
+ * \brief Definitions for sizes of Diffie-Hellman groups elements in Z_p.
+ *
+ * Tor uses these definitions throughout its codebase, even in parts that
+ * don't actually do any Diffie-Hellman calculations.
+ **/
+
#ifndef TOR_DH_SIZES_H
#define TOR_DH_SIZES_H
diff --git a/src/lib/defs/x25519_sizes.h b/src/lib/defs/x25519_sizes.h
index adaaab8c4d..d8ada46b97 100644
--- a/src/lib/defs/x25519_sizes.h
+++ b/src/lib/defs/x25519_sizes.h
@@ -4,6 +4,15 @@
* Copyright (c) 2007-2018, The Tor Project, Inc. */
/* See LICENSE for licensing information */
+/**
+ * \file x25519_sizes.h
+
+ * \brief Definitions for sizes of x25519 keys and elements.
+ *
+ * Tor uses these definitions throughout its codebase, even in parts that
+ * don't actually do any x25519 calculations.
+ **/
+
#ifndef TOR_X25519_SIZES_H
#define TOR_X25519_SIZES_H