]> git.tue.mpg.de Git - paraslash.git/commitdiff
score.c: Shorten documentation of get_score_of_row().
authorAndre Noll <maan@tuebingen.mpg.de>
Mon, 7 Mar 2022 21:25:24 +0000 (22:25 +0100)
committerAndre Noll <maan@tuebingen.mpg.de>
Thu, 24 Mar 2022 19:00:46 +0000 (20:00 +0100)
This function is static, and its implementation is shorter than its
documentation, which mostly consists of pointless boilerplate text.

score.c

diff --git a/score.c b/score.c
index 983589333f088b600d85d9c0271044d7a21f8eb7..43b788e5a14441e7448b3dd294b3ad5d70381253 100644 (file)
--- 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;