score: Improve documentation of score_update().
authorAndre Noll <maan@systemlinux.org>
Wed, 4 Sep 2013 20:05:00 +0000 (20:05 +0000)
committerAndre Noll <maan@systemlinux.org>
Wed, 4 Sep 2013 22:23:13 +0000 (22:23 +0000)
Remove a stray "and" and the list of possible errors, which is not
very useful and possibly incomplete.

score.c

diff --git a/score.c b/score.c
index ca94e8d..37f4c55 100644 (file)
--- a/score.c
+++ b/score.c
@@ -168,13 +168,11 @@ static int get_nth_score(unsigned n, long *score)
  * \param aft_row Determines the audio file to change.
  * \param percent The position to re-insert the audio file.
  *
- * The percent parameter must be between \p 0 and 100 and. A value of zero
- * means to re-insert the audio file into the score table with a score lower
- * than any other admissible file.
+ * The percent parameter must be between 0 and 100. A value of zero means to
+ * re-insert the audio file into the score table with a score lower than any
+ * other admissible file.
  *
- * \return Positive on success, negative on errors. Possible errors: Errors
- * returned by osl_get_row(), get_num_admissible_files(), osl_get_nth_row(),
- * osl_get_object(), osl_update_object().
+ * \return Positive on success, negative on errors.
  */
 int score_update(const struct osl_row *aft_row, long percent)
 {