diff options
author | Thomas White <taw@physics.org> | 2019-05-07 16:10:17 +0200 |
---|---|---|
committer | Thomas White <taw@physics.org> | 2019-05-07 16:25:44 +0200 |
commit | 1bed7848a99aba510726b3fa287b1d7a3f75dfa6 (patch) | |
tree | ddeea6dc2a6a23c80a8d5f76ae8fd4548b8ac3c7 /libcrystfel/src/symmetry.h | |
parent | 66ec127e34d2f732e65be61897347edf17bdb4e1 (diff) |
Update all source code comments to Doxygen format
Diffstat (limited to 'libcrystfel/src/symmetry.h')
-rw-r--r-- | libcrystfel/src/symmetry.h | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/libcrystfel/src/symmetry.h b/libcrystfel/src/symmetry.h index ab2aa934..42a2b9fb 100644 --- a/libcrystfel/src/symmetry.h +++ b/libcrystfel/src/symmetry.h @@ -39,8 +39,11 @@ #include "rational.h" /** - * SymOpList - * + * \file symmetry.h + * Point group symmetry + */ + +/** * The SymOpList is an opaque data structure containing a list of point symmetry * operations. It could represent an point group or a list of indexing * ambiguities (twin laws), or similar. @@ -48,11 +51,9 @@ typedef struct _symoplist SymOpList; /** - * SymOpMask - * * The SymOpMask is an opaque data structure containing a list of flags - * associated with point symmetry operations in a specific %SymOpList. It is - * used to filter the operations in the %SymOpList to avoid duplicating + * associated with point symmetry operations in a specific \ref SymOpList. It is + * used to filter the operations in the \ref SymOpList to avoid duplicating * equivalent reflections when the reflection is somehow special (e.g. 'hk0'). **/ typedef struct _symopmask SymOpMask; |