From 10a8969c10ac739aa2aa3de826f6bf2aa9940262 Mon Sep 17 00:00:00 2001
From: Thomas White <taw@physics.org>
Date: Fri, 4 Jan 2013 17:32:24 +0100
Subject: Tidy up documentation

---
 libcrystfel/src/index.h | 16 +++++++++++++++-
 1 file changed, 15 insertions(+), 1 deletion(-)

(limited to 'libcrystfel/src/index.h')

diff --git a/libcrystfel/src/index.h b/libcrystfel/src/index.h
index 9d23f3fb..4a724645 100644
--- a/libcrystfel/src/index.h
+++ b/libcrystfel/src/index.h
@@ -43,7 +43,15 @@
 #include "detector.h"
 
 
-/* Indexing methods */
+/**
+ * IndexingMethod:
+ * @INDEXING_NONE: No indexing to be performed
+ * @INDEXING_DIRAX: Invoke DirAx
+ * @INDEXING_MOSFLM: Invoke MOSFLM
+ * @INDEXING_REAX: DPS algorithm using known cell parameters
+ *
+ * An enumeration of all the available indexing methods.
+ **/
 typedef enum {
 	INDEXING_NONE,
 	INDEXING_DIRAX,
@@ -61,6 +69,12 @@ enum {
 };
 
 
+/**
+ * IndexingPrivate:
+ *
+ * This is an opaque data structure containing information needed by the
+ * indexing method.
+ **/
 typedef struct _indexingprivate IndexingPrivate;
 
 extern IndexingPrivate *indexing_private(IndexingMethod indm);
-- 
cgit v1.2.3