mood.c: Improve documentation of struct admissible_file_info.
authorAndre Noll <maan@tuebingen.mpg.de>
Fri, 2 Jan 2015 01:27:15 +0000 (01:27 +0000)
committerAndre Noll <maan@tuebingen.mpg.de>
Mon, 12 Jan 2015 22:29:07 +0000 (23:29 +0100)
mood.c

diff --git a/mood.c b/mood.c
index a2525a7..2c37c06 100644 (file)
--- a/mood.c
+++ b/mood.c
@@ -535,16 +535,16 @@ static int del_afs_statistics(const struct osl_row *row)
 /**
  * Structure used during mood_open().
  *
- * At mood open time, we look at each file in the audio file table in order to
- * determine whether it is admissible. If a file happens to be admissible, its
- * mood score is computed by calling each relevant mood_score_function. Next,
- * we update the afs_statistics and add a struct admissible_file_info to a
- * temporary array.
+ * At mood open time we determine the set of admissible files for the given
+ * mood. The mood score of each admissible file is computed by adding up all
+ * mood item scores. Next, we update the afs statistics and append a struct
+ * admissible_file_info to a temporary array.
  *
- * If all files have been processed that way, the final score of each
+ * When all files have been processed in this way, the final score of each
  * admissible file is computed by adding the dynamic score (which depends on
- * the afs_statistics) to the mood score.  Finally, all audio files in the
- * array are added to the score table and the admissible array is freed.
+ * the afs_statistics and the current time) to the mood score. Finally, all
+ * audio files in the temporary array are added to the score table and the
+ * array is freed.
  *
  * \sa mood_method, admissible_array.
  */