diff options
author | Thomas White <taw@bitwiz.org.uk> | 2011-07-02 23:21:31 +0200 |
---|---|---|
committer | Thomas White <taw@physics.org> | 2012-02-22 15:27:31 +0100 |
commit | 47ba16fe47a0f4802d9744b3886e650fc3ae6fa7 (patch) | |
tree | f7b21355eb2109694eed0b527eecb50f4c6d31f7 /src/cell.c | |
parent | 88cd387d8e0e7e1e6271a3df2fe10e7722ee5976 (diff) |
Work on documentation
Diffstat (limited to 'src/cell.c')
-rw-r--r-- | src/cell.c | 17 |
1 files changed, 17 insertions, 0 deletions
@@ -110,6 +110,13 @@ UnitCell *cell_new() } +/** + * cell_free: + * @cell: A %UnitCell to free. + * + * Frees a %UnitCell, and all internal resources concerning that cell. + * + */ void cell_free(UnitCell *cell) { if ( cell == NULL ) return; @@ -553,6 +560,16 @@ static const char *cell_rep(UnitCell *cell) } +/** + * cell_rotate: + * @in: A %UnitCell to rotate + * @quat: A %quaternion + * + * Rotate a %UnitCell using a %quaternion. + * + * Returns: a newly allocated rotated copy of @in. + * + */ UnitCell *cell_rotate(UnitCell *in, struct quaternion quat) { struct rvec a, b, c; |