aboutsummaryrefslogtreecommitdiff
path: root/libcrystfel/src/cell.h
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2013-01-04 17:32:24 +0100
committerThomas White <taw@physics.org>2013-01-04 17:32:24 +0100
commit10a8969c10ac739aa2aa3de826f6bf2aa9940262 (patch)
tree823e83bf53aa31d94079b37065b09ae73bf057ba /libcrystfel/src/cell.h
parentb227f195cd8e3dfeae0212b1de7bdcb5a6fc837a (diff)
Tidy up documentation
Diffstat (limited to 'libcrystfel/src/cell.h')
-rw-r--r--libcrystfel/src/cell.h25
1 files changed, 23 insertions, 2 deletions
diff --git a/libcrystfel/src/cell.h b/libcrystfel/src/cell.h
index cde25b07..57741b41 100644
--- a/libcrystfel/src/cell.h
+++ b/libcrystfel/src/cell.h
@@ -40,8 +40,15 @@
#include "utils.h"
#include "integer_matrix.h"
-/* A 3D vector in reciprocal space.
- * Note: Heavily abused to serve as a real space vector as well */
+/**
+ * rvec:
+ * @u: x component (in reciprocal space)
+ * @v: y component (in reciprocal space)
+ * @w: z component (in reciprocal space)
+ *
+ * Structure representing a 3D vector in reciprocal space.
+ * Note: Heavily abused to serve as a real space vector as well.
+ **/
struct rvec
{
double u;
@@ -49,6 +56,20 @@ struct rvec
double w;
};
+
+/**
+ * LatticeType:
+ * @L_TRICLINIC: Triclinic lattice
+ * @L_MONOCLINIC: Monoclinic lattice
+ * @L_ORTHORHOMBIC: Orthorhombic lattice
+ * @L_TETRAGONAL: Tetragonal lattice
+ * @L_RHOMBOHEDRAL: Rhombohedral lattice
+ * @L_HEXAGONAL: Hexagonal lattice
+ * @L_CUBIC: Cubic lattice
+ *
+ * An enumeration of the possible lattice types: triclinic, monoclinic,
+ * orthorhombic, tetragonal, rhombohedral, hexagonal and cubic.
+ **/
typedef enum
{
L_TRICLINIC,