From: Andre Noll Date: Thu, 25 Oct 2007 17:30:00 +0000 (+0200) Subject: Small cleanups and documentation improvements. X-Git-Tag: v0.3.0~205 X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=commitdiff_plain;h=e0621e0098d8507095268bc71ece2c778ccde0b3 Small cleanups and documentation improvements. --- diff --git a/afh_common.c b/afh_common.c index 13bcd0d3..e6e77ae4 100644 --- a/afh_common.c +++ b/afh_common.c @@ -3,7 +3,8 @@ * * Licensed under the GPL v2. For licencing details see COPYING. */ -/* \file afh_common.c: Common audio format handler functions. */ + +/** \file afh_common.c Common audio format handler functions. */ #include /* mmap */ #include /* gettimeofday */ @@ -26,7 +27,7 @@ void mp3_init(struct audio_format_handler *); #endif /** - * The list of supported audio formats. + * The list of supported audio formats. * * We always define the full array of audio formats even if some audio formats * were not compiled in. This is because for each audio file the number of its @@ -89,9 +90,9 @@ void afh_init(void) /** - * guess the audio format judging from filename + * Guess the audio format judging from filename. * - * \param name the filename + * \param name The filename. * * \return This function returns -1 if it has no idea what kind of audio * file this might be. Otherwise the (non-negative) number of the audio format diff --git a/afs.cmd b/afs.cmd index f4f26528..38b46e9f 100644 --- a/afs.cmd +++ b/afs.cmd @@ -235,7 +235,7 @@ H: -v Verbose mode. N: select P: AFS_READ | AFS_WRITE D: Activate a mood or a playlist. -U: select : +U: select specifier:name H: The specifier is either 'm' or 'p' to indicate whether a playlist or H: a mood should be activated. Example: H: diff --git a/rbtree.c b/rbtree.c index ed8f0ac7..5d24aeb5 100644 --- a/rbtree.c +++ b/rbtree.c @@ -21,6 +21,8 @@ linux/lib/rbtree.c */ +/** \file rbtree.c Red-black tree implementation. */ + #include "stddef.h" #include "rbtree.h" diff --git a/rbtree.h b/rbtree.h index 1dafb792..38b7752b 100644 --- a/rbtree.h +++ b/rbtree.h @@ -91,6 +91,8 @@ static inline struct page * rb_insert_page_cache(struct inode * inode, ----------------------------------------------------------------------- */ +/** \file rbtree.h Exported symbols from rbtree.h */ + #ifndef _LINUX_RBTREE_H #define _LINUX_RBTREE_H