X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=mm.h;h=28038e729f9bc4ac299aaef04b39546c3b5e3ccd;hp=c1744dcb47e99e2bb533d3a6da97d271efced950;hb=4e50b2401961b6ecc10f5e57d93b376401115395;hpb=9609fd30e0d3db45ede3ab5c6bc3a77c15b6aef8 diff --git a/mm.h b/mm.h index c1744dcb..28038e72 100644 --- a/mm.h +++ b/mm.h @@ -1,8 +1,4 @@ -/* - * Copyright (C) 2007-2009 Andre Noll - * - * Licensed under the GPL v2. For licencing details see COPYING. - */ +/* Copyright (C) 2007 Andre Noll , see file COPYING. */ /** \file mm.h Symbols and declarations for mood methods. */ @@ -17,7 +13,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 +32,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 *);