diff options
| author | Thomas White <taw@physics.org> | 2015-07-20 15:52:38 +0200 |
|---|---|---|
| committer | Thomas White <taw@physics.org> | 2015-07-21 10:18:33 +0200 |
| commit | 466402c6a1b2804c168aa0da40a54842243ca60a (patch) | |
| tree | 65918872bd1b3a9e4db0560dae04bdaa7522bab5 /libcrystfel | |
| parent | d75b852f52b244796c0386c4f21cf36ca5bfcf70 (diff) | |
Update API docs
Diffstat (limited to 'libcrystfel')
| -rw-r--r-- | libcrystfel/src/geometry.c | 9 | ||||
| -rw-r--r-- | libcrystfel/src/index.h | 1 | ||||
| -rw-r--r-- | libcrystfel/src/reflist.c | 2 | ||||
| -rw-r--r-- | libcrystfel/src/utils.c | 8 |
4 files changed, 14 insertions, 6 deletions
diff --git a/libcrystfel/src/geometry.c b/libcrystfel/src/geometry.c index 3325923c..d8b40a16 100644 --- a/libcrystfel/src/geometry.c +++ b/libcrystfel/src/geometry.c @@ -495,7 +495,14 @@ static void set_unity_partialities(Crystal *cryst) } -/* Calculate partialities and apply them to the image's reflections */ +/** + * update_partialities: + * @cryst: A %Crystal + * @pmodel: A %PartialityModel + * + * Updates the partialities of @cryst's reflections according to @pmodel and + * the current state of the crystal (e.g. its unit cell parameters). + */ void update_partialities(Crystal *cryst, PartialityModel pmodel) { Reflection *refl; diff --git a/libcrystfel/src/index.h b/libcrystfel/src/index.h index 8d5964e4..d835d003 100644 --- a/libcrystfel/src/index.h +++ b/libcrystfel/src/index.h @@ -63,6 +63,7 @@ * @INDEXING_XDS: Invoke XDS * @INDEXING_SIMULATION: Dummy value * @INDEXING_DEBUG: Results injector for debugging + * @INDEXING_ASDF: Use in-built "asdf" indexer * @INDEXING_CHECK_CELL_COMBINATIONS: Check linear combinations of unit cell * axes for agreement with given cell. * @INDEXING_CHECK_CELL_AXES: Check unit cell axes for agreement with given diff --git a/libcrystfel/src/reflist.c b/libcrystfel/src/reflist.c index ccc421f3..2906dc01 100644 --- a/libcrystfel/src/reflist.c +++ b/libcrystfel/src/reflist.c @@ -600,7 +600,7 @@ void set_detector_pos(Reflection *refl, double fs, double ss) /** * set_panel: * @refl: A %Reflection - * @panel: Pointer to the panel structure on which the reflection appears + * @p: Pointer to the panel structure on which the reflection appears * * Note that the pointer will be stored, not the contents of the structure. * diff --git a/libcrystfel/src/utils.c b/libcrystfel/src/utils.c index af0abedc..461da0cd 100644 --- a/libcrystfel/src/utils.c +++ b/libcrystfel/src/utils.c @@ -156,10 +156,10 @@ static int check_eigen(gsl_vector *e_val, int verbose) /** * solve_svd: - * v: a gsl_vector - * M: a gsl_matrix - * n_filt: pointer to store the number of filtered eigenvalues - * verbose: flag for verbosity on the terminal + * @v: a gsl_vector + * @M: a gsl_matrix + * @n_filt: pointer to store the number of filtered eigenvalues + * @verbose: flag for verbosity on the terminal * * Solves the matrix equation M.x = v, returning x. * Performs rescaling and eigenvalue filtering. |