From: Andre Noll <maan@tuebingen.mpg.de>
Date: Mon, 7 Mar 2022 21:25:24 +0000 (+0100)
Subject: score.c: Shorten documentation of get_score_of_row().
X-Git-Tag: v0.7.1~32
X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=commitdiff_plain;h=1ef72d4c554ba2b838adacdf89ed91139c2a8931

score.c: Shorten documentation of get_score_of_row().

This function is static, and its implementation is shorter than its
documentation, which mostly consists of pointless boilerplate text.
---

diff --git a/score.c b/score.c
index 98358933..43b788e5 100644
--- a/score.c
+++ b/score.c
@@ -92,16 +92,7 @@ int get_num_admissible_files(unsigned *num)
 	return osl(osl_get_num_rows(score_table, num));
 }
 
-/**
- * Get the score of the audio file associated with given row of the score table.
- *
- * \param score_row Pointer to the row in the score table.
- * \param score Result is returned here on success.
- *
- * On errors (negative return value) the content of \a score is undefined.
- *
- * \return The return value of the underlying call to osl_get_object().
- */
+/* On errors (negative return value) the content of score is undefined. */
 static int get_score_of_row(void *score_row, long *score)
 {
 	struct osl_object obj;