From 466402c6a1b2804c168aa0da40a54842243ca60a Mon Sep 17 00:00:00 2001
From: Thomas White <taw@physics.org>
Date: Mon, 20 Jul 2015 15:52:38 +0200
Subject: Update API docs

---
 libcrystfel/src/geometry.c | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

(limited to 'libcrystfel/src/geometry.c')

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;
-- 
cgit v1.2.3