aboutsummaryrefslogtreecommitdiff
path: root/src/lib/math
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2018-07-01 20:22:55 -0400
committerNick Mathewson <nickm@torproject.org>2018-07-01 20:22:55 -0400
commitcb1a3674ebb3826d9e1e56146210bd79cb4a42f0 (patch)
tree84382a222e7d271efb8426560b61fb1a28ec4e05 /src/lib/math
parent83a4946e7b9d2bb75ab8dfa8073c5dd7b3f77bc9 (diff)
downloadtor-cb1a3674ebb3826d9e1e56146210bd79cb4a42f0.tar.gz
tor-cb1a3674ebb3826d9e1e56146210bd79cb4a42f0.zip
File-level documentation for some of src/lib.
Diffstat (limited to 'src/lib/math')
-rw-r--r--src/lib/math/fp.c6
-rw-r--r--src/lib/math/fp.h6
-rw-r--r--src/lib/math/laplace.c6
-rw-r--r--src/lib/math/laplace.h6
4 files changed, 24 insertions, 0 deletions
diff --git a/src/lib/math/fp.c b/src/lib/math/fp.c
index d1c4428251..d5989db637 100644
--- a/src/lib/math/fp.c
+++ b/src/lib/math/fp.c
@@ -3,6 +3,12 @@
* Copyright (c) 2007-2018, The Tor Project, Inc. */
/* See LICENSE for licensing information */
+/**
+ * \file fp.c
+ *
+ * \brief Basic floating-point compatibility and convenience code.
+ **/
+
#include "orconfig.h"
#include "lib/math/fp.h"
diff --git a/src/lib/math/fp.h b/src/lib/math/fp.h
index b35c18a1c7..e27b8f8d80 100644
--- a/src/lib/math/fp.h
+++ b/src/lib/math/fp.h
@@ -3,6 +3,12 @@
* Copyright (c) 2007-2018, The Tor Project, Inc. */
/* See LICENSE for licensing information */
+/**
+ * \file fp.h
+ *
+ * \brief Header for fp.c
+ **/
+
#ifndef TOR_FP_H
#define TOR_FP_H
diff --git a/src/lib/math/laplace.c b/src/lib/math/laplace.c
index 8e45a1fb33..6b33b46902 100644
--- a/src/lib/math/laplace.c
+++ b/src/lib/math/laplace.c
@@ -3,6 +3,12 @@
* Copyright (c) 2007-2018, The Tor Project, Inc. */
/* See LICENSE for licensing information */
+/**
+ * \file laplace.c
+ *
+ * \brief Implements a Laplace distribution, used for adding noise to things.
+ **/
+
#include "orconfig.h"
#include "lib/math/laplace.h"
#include "lib/math/fp.h"
diff --git a/src/lib/math/laplace.h b/src/lib/math/laplace.h
index b22862e64a..62d698e369 100644
--- a/src/lib/math/laplace.h
+++ b/src/lib/math/laplace.h
@@ -3,6 +3,12 @@
* Copyright (c) 2007-2018, The Tor Project, Inc. */
/* See LICENSE for licensing information */
+/**
+ * \file laplace.h
+ *
+ * \brief Header for laplace.c
+ **/
+
#ifndef TOR_LAPLACE_H
#define TOR_LAPLACE_H