aboutsummaryrefslogtreecommitdiff
path: root/libcrystfel/src/spectrum.h
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2019-05-15 17:02:21 +0200
committerThomas White <taw@physics.org>2019-05-15 17:02:21 +0200
commit6aa34aa38aa2116ff69861c1857dac96fa8c9361 (patch)
tree887657817cfc83fa5c6f021f9be8426f4613d5f6 /libcrystfel/src/spectrum.h
parenta68c03522a0eafadd1cdcb635896c4be76e665c8 (diff)
Spectrum API clarifications
Diffstat (limited to 'libcrystfel/src/spectrum.h')
-rw-r--r--libcrystfel/src/spectrum.h6
1 files changed, 3 insertions, 3 deletions
diff --git a/libcrystfel/src/spectrum.h b/libcrystfel/src/spectrum.h
index 2bcd0322..b3786c53 100644
--- a/libcrystfel/src/spectrum.h
+++ b/libcrystfel/src/spectrum.h
@@ -51,9 +51,9 @@ typedef struct _spectrum Spectrum;
*/
struct gaussian
{
- double kcen;
- double sigma;
- double height;
+ double kcen; /**< k value at centre of Gaussian (in 1/m) */
+ double sigma; /**< Standard deviation of Gaussian (in 1/m) */
+ double height; /**< Height of Gaussian (arbitrary units) */
};