aboutsummaryrefslogtreecommitdiff
path: root/libcrystfel/src
diff options
context:
space:
mode:
Diffstat (limited to 'libcrystfel/src')
-rw-r--r--libcrystfel/src/detector.c2
-rw-r--r--libcrystfel/src/image.h9
-rw-r--r--libcrystfel/src/integration.h17
-rw-r--r--libcrystfel/src/stream.c3
-rw-r--r--libcrystfel/src/symmetry.c6
-rw-r--r--libcrystfel/src/utils.c3
6 files changed, 35 insertions, 5 deletions
diff --git a/libcrystfel/src/detector.c b/libcrystfel/src/detector.c
index eb5890b5..537f1f30 100644
--- a/libcrystfel/src/detector.c
+++ b/libcrystfel/src/detector.c
@@ -1408,7 +1408,7 @@ int write_detector_geometry(const char *filename, struct detector *det)
/**
- * mark_resolution_range_as_bad()
+ * mark_resolution_range_as_bad:
* @image: An image structure
* @min: Minimum value of 1/d to be marked as bad
* @max: Maximum value of 1/d to be marked as bad
diff --git a/libcrystfel/src/image.h b/libcrystfel/src/image.h
index f19a7427..69edb768 100644
--- a/libcrystfel/src/image.h
+++ b/libcrystfel/src/image.h
@@ -48,6 +48,15 @@ struct image;
#include "crystal.h"
#include "index.h"
+/**
+ * SpectrumType:
+ * @SPECTRUM_TOPHAT: A top hat distribution of wavelengths
+ * @SPECTRUM_SASE: A simulated SASE spectrum
+ * @SPECTRUM_TWOCOLOUR: A spectrum containing two peaks
+ *
+ * A %SpectrumType represents a type of X-ray energy spectrum to use for
+ * generating simulated data.
+ **/
typedef enum {
SPECTRUM_TOPHAT,
SPECTRUM_SASE,
diff --git a/libcrystfel/src/integration.h b/libcrystfel/src/integration.h
index 9e1c8ee1..ca04157a 100644
--- a/libcrystfel/src/integration.h
+++ b/libcrystfel/src/integration.h
@@ -36,6 +36,23 @@
#include "geometry.h"
+/**
+ * IntDiag:
+ * @INTDIAG_NONE: Never show diagnostics
+ * @INTDIAG_RANDOM: Show diagnostics for a randomly selected 1% of reflections
+ * @INTDIAG_ALL: Show diagnostics for all reflections
+ * @INTDIAG_INDICES: Show diagnostics when the Miller indices of the reflection
+ * are the ones specified
+ * @INTDIAG_NEGATIVE: Show diagnostics when the measured intensity is less than
+ * minus three times its estimated error.
+ * @INTDIAG_IMPLAUSIBLE: Show diagnostics when the measured intensity is les
+ * than minus five times its estimated error.
+ * @INTDIAG_STRONG: Show diagnostics when the measured intensity is more than
+ * three times its estimated error.
+ *
+ * An %IntDiag describes the condition under which the integration subsystem
+ * should display diagnostic information to the user.
+ **/
typedef enum {
INTDIAG_NONE,
diff --git a/libcrystfel/src/stream.c b/libcrystfel/src/stream.c
index fd051884..f50d2a2b 100644
--- a/libcrystfel/src/stream.c
+++ b/libcrystfel/src/stream.c
@@ -899,6 +899,9 @@ Stream *open_stream_fd_for_write(int fd)
/**
* open_stream_for_write_2
* @filename: Filename of new stream
+ * @geom_filename: The geometry filename to copy
+ * @argc: The number of arguments to the program
+ * @argv: The arguments to the program
*
* Creates a new stream with name @filename, and adds the stream format
* and version header, plus a verbatim copy of the geometry file
diff --git a/libcrystfel/src/symmetry.c b/libcrystfel/src/symmetry.c
index 266ada66..48d5004e 100644
--- a/libcrystfel/src/symmetry.c
+++ b/libcrystfel/src/symmetry.c
@@ -212,9 +212,9 @@ static void add_symop_v(SymOpList *ops,
* @m: A %SymOpMask
* @idx: Index of the operation to get
*
- * Returns a pointer to an integer matrix specifying a symmetry operation
- * contained in the symmetry operator list, and identified by the specified
- * index.
+ * This function returns a pointer to an integer matrix specifying a symmetry
+ * operation contained in the symmetry operator list, and identified by the
+ * specified index.
**/
IntegerMatrix *get_symop(const SymOpList *ops, const SymOpMask *m, int idx)
{
diff --git a/libcrystfel/src/utils.c b/libcrystfel/src/utils.c
index 0972c710..e09b53c3 100644
--- a/libcrystfel/src/utils.c
+++ b/libcrystfel/src/utils.c
@@ -283,6 +283,7 @@ struct quaternion normalise_quaternion(struct quaternion q)
/**
* random_quaternion:
+ * @rng: A GSL random number generator to use
*
* Returns: a randomly generated, normalised, quaternion.
**/
@@ -328,7 +329,7 @@ int quaternion_valid(struct quaternion q)
/**
* quat_rot
- * @q: A vector (in the form of an %rvec)
+ * @q: A vector (in the form of a "struct rvec")
* @z: A %quaternion
*
* Rotates a vector according to a quaternion.