From: Andre Noll <maan@tuebingen.mpg.de>
Date: Tue, 15 Mar 2022 20:47:08 +0000 (+0100)
Subject: score.c: Improve documentation of score_compare().
X-Git-Tag: v0.7.1~31
X-Git-Url: http://git.tue.mpg.de/?a=commitdiff_plain;h=1333cbe28098842254160558af711fb83ffd2def;p=paraslash.git

score.c: Improve documentation of score_compare().

Reword the text to focus on why we dance twice. Also put it on dedox
because it is static.
---

diff --git a/score.c b/score.c
index 43b788e5..823cf28d 100644
--- a/score.c
+++ b/score.c
@@ -21,15 +21,11 @@ static int ptr_compare(const struct osl_object *obj1, const struct osl_object *o
 	return NUM_COMPARE(d1, d2);
 }
 
-/**
- * Compare the score of two audio files
- *
- * \param obj1 Pointer to the first score object.
- * \param obj2 Pointer to the second score object.
- *
- * This function first compares the score values as usual integers. If they compare as
- * equal, the address of \a obj1 and \a obj2 are compared. So this compare function
- * returns zero if and only if \a obj1 and \a obj2 point to the same memory area.
+/*
+ * This function first compares the score values. If they are equal, the
+ * addresses of the two objects are compared. Thus, the function returns
+ * "equal" only if the two objects alias each other, i.e., point to the same
+ * memory address.
  */
 static int score_compare(const struct osl_object *obj1, const struct osl_object *obj2)
 {