diff options
author | Thomas White <taw@physics.org> | 2012-10-20 05:58:30 -0700 |
---|---|---|
committer | Thomas White <taw@bitwiz.org.uk> | 2012-10-20 06:38:29 -0700 |
commit | b8b1b1ddb214823e3d9a0a30e3613399e52b87b0 (patch) | |
tree | 764b7afb33b0dfd4a796cca2b9f693d4bc9de846 /libcrystfel | |
parent | d33230479371986bd58fc3ddc129ef91db4868d7 (diff) |
Update documentation
Diffstat (limited to 'libcrystfel')
-rw-r--r-- | libcrystfel/src/cell-utils.c | 17 | ||||
-rw-r--r-- | libcrystfel/src/integer_matrix.c | 2 |
2 files changed, 18 insertions, 1 deletions
diff --git a/libcrystfel/src/cell-utils.c b/libcrystfel/src/cell-utils.c index 74f33bb2..174240b6 100644 --- a/libcrystfel/src/cell-utils.c +++ b/libcrystfel/src/cell-utils.c @@ -71,6 +71,8 @@ * * Rotate a %UnitCell using a %quaternion. * + * Deprecated: 0.4.3. Use tfn_random_rotation() and cell_transform() instead. + * * Returns: a newly allocated rotated copy of @in. * */ @@ -1045,6 +1047,21 @@ void cell_fudge_gslcblas() } +/** + * rotate_cell: + * @in: A %UnitCell to rotate + * @omega: Euler angle about +z + * @phi: Euler angle about +x + * @rot: Euler angle about new +z + * + * Rotate a %UnitCell using Euler angles + * + * Deprecated: Deprecated since 0.4.3. Use tfn_random_rotation() and + * cell_transform() instead. + * + * Returns: a newly allocated rotated copy of @in. + * + */ UnitCell *rotate_cell(UnitCell *in, double omega, double phi, double rot) { UnitCell *out; diff --git a/libcrystfel/src/integer_matrix.c b/libcrystfel/src/integer_matrix.c index ad38a9fe..32784f20 100644 --- a/libcrystfel/src/integer_matrix.c +++ b/libcrystfel/src/integer_matrix.c @@ -47,7 +47,7 @@ * @include: "integer_matrix.h" * @Image: * - * Routines to handle integer matrix + * An integer matrix library */ |