aboutsummaryrefslogtreecommitdiff
path: root/libcrystfel/src/rational.h
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2019-05-07 16:10:17 +0200
committerThomas White <taw@physics.org>2019-05-07 16:25:44 +0200
commit1bed7848a99aba510726b3fa287b1d7a3f75dfa6 (patch)
treeddeea6dc2a6a23c80a8d5f76ae8fd4548b8ac3c7 /libcrystfel/src/rational.h
parent66ec127e34d2f732e65be61897347edf17bdb4e1 (diff)
Update all source code comments to Doxygen format
Diffstat (limited to 'libcrystfel/src/rational.h')
-rw-r--r--libcrystfel/src/rational.h9
1 files changed, 5 insertions, 4 deletions
diff --git a/libcrystfel/src/rational.h b/libcrystfel/src/rational.h
index 23c918cf..e67c603a 100644
--- a/libcrystfel/src/rational.h
+++ b/libcrystfel/src/rational.h
@@ -34,8 +34,11 @@
#endif
/**
- * Rational
- *
+ * \file rational.h
+ * %Rational numbers (including rational matrices)
+ */
+
+/**
* The Rational is an opaque-ish data structure representing a rational number.
*
* "Opaque-ish" means that the structure isn't technically opaque, allowing you
@@ -50,8 +53,6 @@ typedef struct {
/**
- * RationalMatrix
- *
* The RationalMatrix is an opaque data structure representing a matrix of
* rational numbers.
**/