aboutsummaryrefslogtreecommitdiff
path: root/libcrystfel/src/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/utils.h
parent66ec127e34d2f732e65be61897347edf17bdb4e1 (diff)
Update all source code comments to Doxygen format
Diffstat (limited to 'libcrystfel/src/utils.h')
-rw-r--r--libcrystfel/src/utils.h20
1 files changed, 8 insertions, 12 deletions
diff --git a/libcrystfel/src/utils.h b/libcrystfel/src/utils.h
index 65ab9b00..cd21bd93 100644
--- a/libcrystfel/src/utils.h
+++ b/libcrystfel/src/utils.h
@@ -46,6 +46,11 @@
#include "thread-pool.h"
+/**
+ * \file utils.h
+ * Miscellaneous utility functions
+ */
+
/* -------------------------- Fundamental constants ------------------------ */
/* Electron charge in C */
@@ -75,13 +80,11 @@ extern size_t notrail(char *s);
extern void chomp(char *s);
/**
- * AssplodeFlag:
- * @ASSPLODE_NONE: Nothing
- * @ASSPLODE_DUPS: Don't merge deliminators
+ * Controls the behaviour of \ref assplode.
**/
typedef enum {
- ASSPLODE_NONE = 0,
- ASSPLODE_DUPS = 1<<0
+ ASSPLODE_NONE = 0, /**< Nothing */
+ ASSPLODE_DUPS = 1<<0 /**< Don't merge deliminators */
} AssplodeFlag;
extern int assplode(const char *a, const char *delims, char ***pbits,
AssplodeFlag flags);
@@ -237,14 +240,7 @@ extern void strip_extension(char *bfn);
/* ------------------------------ Quaternions ------------------------------- */
/**
- * quaternion:
- * @w: component
- * @x: component
- * @y: component
- * @z: component
- *
* A structure representing a quaternion.
- *
**/
struct quaternion;