Small cleanups and documentation improvements.
authorAndre Noll <maan@systemlinux.org>
Thu, 25 Oct 2007 17:30:00 +0000 (19:30 +0200)
committerAndre Noll <maan@systemlinux.org>
Thu, 25 Oct 2007 17:30:00 +0000 (19:30 +0200)
afh_common.c
afs.cmd
rbtree.c
rbtree.h

index 13bcd0d..e6e77ae 100644 (file)
@@ -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 <sys/mman.h> /* mmap */
 #include <sys/time.h> /* 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 f4f2652..38b46e9 100644 (file)
--- 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 <specifier>:<name>
+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:
index ed8f0ac..5d24aeb 100644 (file)
--- 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"
 
index 1dafb79..38b7752 100644 (file)
--- 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