aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas White <taw@bitwiz.org.uk>2011-07-03 10:19:29 +0200
committerThomas White <taw@physics.org>2012-02-22 15:27:31 +0100
commit4e3506822388a9683362fabb75330dde34be442d (patch)
tree9f2b1171b5574e30156df0bbf67ee06f4676e005
parent9bc1d2a91ab59f63355c38380c0eb64c826ba594 (diff)
More documentation
-rw-r--r--doc/reference/CrystFEL-sections.txt2
-rw-r--r--src/detector.c13
-rw-r--r--src/statistics.c12
-rw-r--r--src/symmetry.c12
4 files changed, 39 insertions, 0 deletions
diff --git a/doc/reference/CrystFEL-sections.txt b/doc/reference/CrystFEL-sections.txt
index aff52a00..ca01c6f9 100644
--- a/doc/reference/CrystFEL-sections.txt
+++ b/doc/reference/CrystFEL-sections.txt
@@ -129,6 +129,8 @@ modulus
poisson_noise
notrail
smallest
+ph_en_to_lambda
+ph_lambda_to_en
</SECTION>
<SECTION>
diff --git a/src/detector.c b/src/detector.c
index 47c9e488..40752019 100644
--- a/src/detector.c
+++ b/src/detector.c
@@ -26,6 +26,19 @@
#include "hdf5-file.h"
+/**
+ * SECTION:detector
+ * @short_description: Detector geometry
+ * @title: Detector
+ * @section_id:
+ * @see_also:
+ * @include: "detector.h"
+ * @Image:
+ *
+ * This structure represents the detector geometry
+ */
+
+
static int atob(const char *a)
{
if ( strcasecmp(a, "true") == 0 ) return 1;
diff --git a/src/statistics.c b/src/statistics.c
index 791952b8..0a776215 100644
--- a/src/statistics.c
+++ b/src/statistics.c
@@ -23,6 +23,18 @@
#include "statistics.h"
#include "utils.h"
+/**
+ * SECTION:statistics
+ * @short_description: Intensity statistics and R-factors
+ * @title: Statistics
+ * @section_id:
+ * @see_also:
+ * @include: "statistics.h"
+ * @Image:
+ *
+ * These functions are for calculating various figures of merit.
+ */
+
struct r_params {
RefList *list1;
diff --git a/src/symmetry.c b/src/symmetry.c
index dc0d2e86..a066ca47 100644
--- a/src/symmetry.c
+++ b/src/symmetry.c
@@ -26,6 +26,18 @@
#define SYM_DEBUG(...)
#endif /* DEBUG */
+/**
+ * SECTION:symmetry
+ * @short_description: Point symmetry handling
+ * @title: Symmetry
+ * @section_id:
+ * @see_also:
+ * @include: "symmetry.h"
+ * @Image:
+ *
+ * Routines to handle point symmetry.
+ */
+
/* Check if a reflection is in the asymmetric unit cell */
static int check_cond(signed int h, signed int k, signed int l, const char *sym)