From 1c13a85b311f7029f87413b4472412546eabd3af Mon Sep 17 00:00:00 2001
From: Thomas White <taw@bitwiz.org.uk>
Date: Tue, 29 Mar 2011 10:37:01 +0200
Subject: More documentation

---
 src/image.h | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'src/image.h')

diff --git a/src/image.h b/src/image.h
index 92047aa1..d6e22aee 100644
--- a/src/image.h
+++ b/src/image.h
@@ -103,6 +103,14 @@ typedef struct _imagefeaturelist ImageFeatureList;
  * by-product of the scattering vector calculation and can be used later for
  * calculating intensities from differential scattering cross sections.
  *
+ * <structfield>candidate_cells</structfield> is an array of unit cells directly
+ * returned by the low-level indexing system. <structfield>ncells</structfield>
+ * is the number of candidate unit cells which were found.  The maximum number
+ * of cells which may be returned is <function>MAX_CELL_CANDIDATES</function>.
+ * <structfield>indexed_cell</structfield> contains the "correct" unit cell
+ * after cell reduction or matching has been performed.  The job of the cell
+ * reduction is to convert the list of candidate cells into a single indexed
+ * cell, or <function>NULL</function> on failure.
  **/
 struct image;
 
-- 
cgit v1.2.3