diff options
author | Thomas White <taw@physics.org> | 2011-07-26 12:21:34 +0200 |
---|---|---|
committer | Thomas White <taw@physics.org> | 2012-02-22 15:27:34 +0100 |
commit | 2653e2f84c9886c27af4f0b4b54d159882a366a1 (patch) | |
tree | 7372f5171de1f5abcd248191169d21af71d5a97f /src/symmetry.h | |
parent | 254af4bd87126095223cd8b722a2aaef79c75dd5 (diff) |
Update docs
Diffstat (limited to 'src/symmetry.h')
-rw-r--r-- | src/symmetry.h | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/src/symmetry.h b/src/symmetry.h index c91864bb..071ebbde 100644 --- a/src/symmetry.h +++ b/src/symmetry.h @@ -20,14 +20,19 @@ /** * SymOpList * - * Opaque type. + * 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. **/ typedef struct _symoplist SymOpList; /** * SymOpMask * - * Opaque type. + * 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 + * equivalent reflections when the reflection is somehow special (e.g. 'hk0'). **/ typedef struct _symopmask SymOpMask; |