trivial doxygen cleanups

[paraslash.git] / afs.c

diff --git a/afs.c b/afs.c
index f5de6609e4f9c87058676068f3172888106393b9..13a9ccb26a066760bd23c758e3384dbf2057bcfc 100644 (file)
--- a/afs.c
+++ b/afs.c
@@ -1,23 +1,11 @@
 /*
  * Copyright (C) 2005-2007 Andre Noll <maan@systemlinux.org>
  *
- *     This program is free software; you can redistribute it and/or modify
- *     it under the terms of the GNU General Public License as published by
- *     the Free Software Foundation; either version 2 of the License, or
- *     (at your option) any later version.
- *
- *     This program is distributed in the hope that it will be useful,
- *     but WITHOUT ANY WARRANTY; without even the implied warranty of
- *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *     GNU General Public License for more details.
- *
- *     You should have received a copy of the GNU General Public License
- *     along with this program; if not, write to the Free Software
- *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
 
-/** \file afs.c functions common to all audio file selectors */
+/** \file afs.c Functions common to all audio file selectors. */
 
 #include "server.cmdline.h"
 #include "server.h"
@@ -29,12 +17,12 @@
 #include "string.h"
 
 /**
- * traverse the given directory recursively
+ * Traverse the given directory recursively.
  *
- * @param dirname the directory to traverse
- * @param f: the function to call for each entry.
+ * \param dirname The directory to traverse.
+ * \param f The function to call for each entry.
  *
- * for each regular file whose filename ends in .yyy, where yyy is a supported
+ * For each regular file whose filename ends in .yyy, where yyy is a supported
  * audio format, the supplied function \a f is called.  The directory and
  * filename component of the regular file are passed to \a f.
  *
@@ -52,9 +40,8 @@ int find_audio_files(const char *dirname, int (*f)(const char *, const char *))
         */
        int cwd_fd = open(".", O_RDONLY);
        struct stat s;
-       int ret = -1;
+       int ret;
 
-//     PARA_DEBUG_LOG("dirname: %s\n", dirname);
        if (cwd_fd < 0)
                return -E_GETCWD;
        ret = -E_CHDIR;