aboutsummaryrefslogtreecommitdiff
path: root/libcrystfel/src/index.h
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2013-12-03 17:24:34 +0100
committerThomas White <taw@physics.org>2013-12-03 17:24:34 +0100
commitca5db9466bf7da04f61f9bc86463bfdcdc025ecf (patch)
tree88a9c5867fe4addd9e827af82db98c16adf114f3 /libcrystfel/src/index.h
parente93f8d734b509cc75028d6ad41d2ca842cbdf57f (diff)
Update docs
Diffstat (limited to 'libcrystfel/src/index.h')
-rw-r--r--libcrystfel/src/index.h7
1 files changed, 5 insertions, 2 deletions
diff --git a/libcrystfel/src/index.h b/libcrystfel/src/index.h
index e71a4c6f..e36e531c 100644
--- a/libcrystfel/src/index.h
+++ b/libcrystfel/src/index.h
@@ -67,7 +67,8 @@
* @INDEXING_MOSFLM: Invoke MOSFLM
* @INDEXING_REAX: DPS algorithm using known cell parameters
* @INDEXING_GRAINSPOTTER: Invoke GrainSpotter
- * @INDEXING_XDS: Invokve XDS
+ * @INDEXING_XDS: Invoke XDS
+ * @INDEXING_SIMULATION: Dummy value
* @INDEXING_CHECK_CELL_COMBINATIONS: Check linear combinations of unit cell
* axes for agreement with given cell.
* @INDEXING_CHECK_CELL_AXES: Check unit cell axes for agreement with given
@@ -79,7 +80,9 @@
* @INDEXING_USE_CELL_PARAMETERS: Use the unit cell parameters to guide the
* indexingprocess.
*
- * An enumeration of all the available indexing methods.
+ * An enumeration of all the available indexing methods. The dummy value
+ * @INDEXING_SIMULATION is used by partial_sim to indicate that no indexing was
+ * performed, and that the indexing results are just from simulation.
**/
typedef enum {