From e5043fb50d3dffee443a33e5a4df1c088038b4de Mon Sep 17 00:00:00 2001
From: Thomas White <taw@physics.org>
Date: Wed, 20 Oct 2021 12:03:11 +0200
Subject: Add a comment

---
 libcrystfel/src/symmetry.c | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'libcrystfel')

diff --git a/libcrystfel/src/symmetry.c b/libcrystfel/src/symmetry.c
index f641a850..312470c7 100644
--- a/libcrystfel/src/symmetry.c
+++ b/libcrystfel/src/symmetry.c
@@ -201,6 +201,9 @@ static void add_symop_v(SymOpList *ops,
  * This function returns a pointer to an integer matrix specifying a symmetry
  * operation contained in the symmetry operator list, and identified by the
  * specified index.
+ *
+ * The returned IntegerMatrix is owned by the SymOpList and must not be
+ * freed separately.  It is valid as long as 'ops' exists.
  **/
 IntegerMatrix *get_symop(const SymOpList *ops, const SymOpMask *m, int idx)
 {
-- 
cgit v1.2.3