X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=mm.h;h=e6c0d125d88594d78a9ad7b3a639375fd883cb6f;hp=2caace7f84220c23119ccb7d1bd7140212086a6a;hb=463b82370e584a8b871311583bf9657cadd1b6cc;hpb=9b406cbe5d20ba969713ca3d7a8033e697476d75 diff --git a/mm.h b/mm.h index 2caace7f..e6c0d125 100644 --- a/mm.h +++ b/mm.h @@ -17,7 +17,7 @@ * Mood score functions must return values between -100 and +100 inclusively. * Boolean score functions should always return either -100 or +100. * - * \sa struct mood_method, mood_parser. + * \sa struct \ref mood_method, \ref mood_parser. */ typedef int mood_score_function(const char *path, const struct afs_info *afsi, const struct afh_info *afhi, const void *data); @@ -36,19 +36,15 @@ typedef int mood_score_function(const char *path, const struct afs_info *afsi, * later in the mood_score_function of the mood_method. The mood_parser may * store a pointer to its structure via the void** pointer. * - * \sa mood_open(), mood_cleanup_function, mood_score_function. + * \sa \ref mood_cleanup_function, \ref mood_score_function. */ typedef int mood_parser(int, char **, void **); /** * Deallocate resources which were allocated by the mood_parser. * - * This optional function of a mood_method is used to free any resources - * allocated in mood_open() by the mood_parser. The argument passed is a - * pointer to the mood_method specific data structure that was returned by the - * mood_parser. - * - * \sa mood_parser. + * Function to free the resources allocated in \ref mood_method::parser. The + * argument is a pointer to mood method specific data returned by ->parser(). */ typedef void mood_cleanup_function(void *);