-/*
- * Copyright (C) 2007-2014 Andre Noll <maan@tuebingen.mpg.de>
- *
- * Licensed under the GPL v2. For licencing details see COPYING.
- */
+/* Copyright (C) 2007 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
/** \file mm.h Symbols and declarations for mood methods. */
* 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);
* 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 *);