Add documentation for search_peaks_peakfinder8

1 files changed, 16 insertions, 0 deletions

diff --git a/libcrystfel/src/peaks.c b/libcrystfel/src/peaks.c
index f5ce8486..a45a51af 100644
--- a/libcrystfel/src/peaks.c
+++ b/libcrystfel/src/peaks.c
@@ -551,6 +551,22 @@ void search_peaks(struct image *image, float threshold, float min_sq_gradient,
 }
 
 
+/**
+ * \param image An \ref image structure
+ * \param max_n_peaks The maximum number of peaks to be searched for
+ * \param threshold The image threshold value, in detector units
+ * \param min_snr The minimum signal to noise ratio for a peak
+ * \param min_pix_count The minimum number of pixels in a peak
+ * \param max_pix_count The maximum number of pixels in a peak
+ * \param local_bg_radius The averaging radius for background calculation
+ * \param min_res The minimum number of pixels out from the center
+ * \param max_res The maximum number of pixels out from the center
+ * \param use_saturated Whether saturated peaks should be considered
+ *
+ * Runs the peakfinder8 peak search algorithm.  This is a thin wrapper which
+ * creates an empty \ref ImageFeatureList for \p image, then calls
+ * the actual \ref peakfinder8 function, found in \ref peakfinder8.h.
+ */
 int search_peaks_peakfinder8(struct image *image, int max_n_peaks,
                               float threshold, float min_snr,
                               int min_pix_count, int max_pix_count,