aboutsummaryrefslogtreecommitdiff
path: root/libcrystfel/src/reflist-utils.h
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2019-05-07 16:10:17 +0200
committerThomas White <taw@physics.org>2019-05-07 16:25:44 +0200
commit1bed7848a99aba510726b3fa287b1d7a3f75dfa6 (patch)
treeddeea6dc2a6a23c80a8d5f76ae8fd4548b8ac3c7 /libcrystfel/src/reflist-utils.h
parent66ec127e34d2f732e65be61897347edf17bdb4e1 (diff)
Update all source code comments to Doxygen format
Diffstat (limited to 'libcrystfel/src/reflist-utils.h')
-rw-r--r--libcrystfel/src/reflist-utils.h13
1 files changed, 12 insertions, 1 deletions
diff --git a/libcrystfel/src/reflist-utils.h b/libcrystfel/src/reflist-utils.h
index c955491a..68695ae2 100644
--- a/libcrystfel/src/reflist-utils.h
+++ b/libcrystfel/src/reflist-utils.h
@@ -31,8 +31,10 @@
#include <config.h>
#endif
+/** @cond */
#ifndef REFLIST_UTILS_H
#define REFLIST_UTILS_H
+/** @endcond */
#include "image.h"
#include "reflist.h"
@@ -43,8 +45,15 @@
extern "C" {
#endif
-#define REFLECTION_END_MARKER "End of reflections"
+/** \file reflist-utils.h
+ *
+ * Reflection list utility functions.
+ */
+/** @cond
+ * Used in stream.c as well, but not part of the API */
+#define REFLECTION_END_MARKER "End of reflections"
+/** @endcond */
extern int write_reflist(const char *filename, RefList *list);
extern int write_reflist_2(const char *filename, RefList *list, SymOpList *sym);
@@ -78,4 +87,6 @@ extern void reflist_add_command_and_version(RefList *list,
}
#endif
+/** @cond */
#endif /* REFLIST_UTILS_H */
+/** @endcond */