Simple doxygen description for files in vfs (not subdirs) directory.

Mostly \file and \brief tag added.

Signed-off-by: Mikhail S. Pobolovets <styx.mp@gmail.com>

vfs/cpio.c

@@ -18,6 +18,12 @@
    License along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
 
+/** \file
+ *  \brief Source: Virtual File System: GNU Tar file system.
+ *  \author Jan Hudec
+ *  \date 2000
+ */
+
 #include <config.h>
 
 #include <errno.h>

vfs/direntry.c

@@ -1,28 +1,33 @@
-/* Directory cache support -- so that you do not have copy of this in
- * each and every filesystem.
+
+/** \file
+ *  \brief Source: directory cache support
+ *
+ *  So that you do not have copy of this in each and every filesystem.
  *
- * Written at 1998 by Pavel Machek <pavel@ucw.cz>, distribute under LGPL.
+ *  Very loosely based on tar.c from midnight and archives.[ch] from
+ *  avfs by Miklos Szeredi (mszeredi@inf.bme.hu)
  *
- * Very loosely based on tar.c from midnight and archives.[ch] from
- * avfs by Miklos Szeredi (mszeredi@inf.bme.hu)
+ *  Unfortunately, I was unable to keep all filesystems
+ *  uniform. tar-like filesystems use tree structure where each
+ *  directory has pointers to its subdirectories. We can do this
+ *  because we have full information about our archive.
  *
- * Unfortunately, I was unable to keep all filesystems
- * uniform. tar-like filesystems use tree structure where each
- * directory has pointers to its subdirectories. We can do this
- * because we have full information about our archive.
+ *  At ftp-like filesystems, situation is a little bit different. When
+ *  you cd /usr/src/linux/drivers/char, you do _not_ want /usr,
+ *  /usr/src, /usr/src/linux and /usr/src/linux/drivers to be
+ *  listed. That means that we do not have complete information, and if
+ *  /usr is symlink to /4, we will not know. Also we have to time out
+ *  entries and things would get messy with tree-like approach. So we
+ *  do different trick: root directory is completely special and
+ *  completely fake, it contains entries such as 'usr', 'usr/src', ...,
+ *  and we'll try to use custom find_entry function.
  *
- * At ftp-like filesystems, situation is a little bit different. When
- * you cd /usr/src/linux/drivers/char, you do _not_ want /usr,
- * /usr/src, /usr/src/linux and /usr/src/linux/drivers to be
- * listed. That means that we do not have complete information, and if
- * /usr is symlink to /4, we will not know. Also we have to time out
- * entries and things would get messy with tree-like approach. So we
- * do different trick: root directory is completely special and
- * completely fake, it contains entries such as 'usr', 'usr/src', ...,
- * and we'll try to use custom find_entry function. 
+ *  \author Pavel Machek <pavel@ucw.cz>, distribute under LGPL.
+ *  \date 1998
  *
- * Paths here do _not_ begin with '/', so root directory of
- * archive/site is simply "". Beware. */
+ *  \warning Paths here do _not_ begin with '/', so root directory of
+ *  archive/site is simply "".
+ */
 
 #include <config.h>
 

vfs/extfs.c

@@ -20,6 +20,15 @@
    License along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
 
+/**
+ * \file
+ * \brief Source: Virtual File System: External file system
+ * \author Jakub Jelinek
+ * \author Pavel Machek
+ * \author Andrew T. Veliath
+ * \date 1995, 1998, 1999
+ */
+
 /* Namespace: init_extfs */
 
 #include <config.h>

vfs/fish.c

@@ -23,12 +23,20 @@
    License along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
 
-/*
+/**
+ * \file
+ * \brief Source: Virtual File System: FISH implementation for transfering files over
+ * shell connections
+ * \author Pavel Machek
+ * \author Michal Svec
+ * \date 1998, 2000
+ *
+ * Derived from ftpfs.c
  * Read README.fish for protocol specification.
  *
  * Syntax of path is: /#sh:user@host[:Cr]/path
- *	where C means you want compressed connection,
- *	and r means you want to use rsh
+ *      where C means you want compressed connection,
+ *      and r means you want to use rsh
  *
  * Namespace: fish_vfs_ops exported.
  */

vfs/fish.h

@@ -1,3 +1,11 @@
+
+/**
+ * \file
+ * \brief Header: Virtual File System: FISH implementation for transfering files over
+ * shell connections
+ */
+
+
 #ifndef MC_VFS_FISH_H
 #define MC_VFS_FISH_H
 

vfs/ftpfs.c

@@ -21,14 +21,23 @@
    You should have received a copy of the GNU Library General Public
    License along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
-   
-/* FTPfs TODO:
 
+/**
+ * \file
+ * \brief Source: Virtual File System: FTP file system
+ * \author Ching Hui
+ * \author Jakub Jelinek
+ * \author Miguel de Icaza
+ * \author Norbert Warmuth
+ * \author Pavel Machek
+ * \date 1995, 1997, 1998
+ *
+ * \todo
 - make it more robust - all the connects etc. should handle EADDRINUSE and
   ERETRY (have I spelled these names correctly?)
 - make the user able to flush a connection - all the caches will get empty
   etc., (tarfs as well), we should give there a user selectable timeout
-  and assign a key sequence.  
+  and assign a key sequence.
 - use hash table instead of linklist to cache ftpfs directory.
 
 What to do with this?
@@ -53,7 +62,7 @@ What to do with this?
 
  */
 
-/* Namespace pollution: horrible */
+/* \todo Fix: Namespace pollution: horrible */
 
 #include <config.h>
 #include <sys/types.h>          /* POSIX-required by sys/socket.h and netdb.h */

vfs/ftpfs.h

@@ -1,3 +1,9 @@
+
+/**
+ * \file
+ * \brief Header: Virtual File System: FTP file system
+ */
+
 #ifndef MC_VFS_FTPFS_H
 #define MC_VFS_FTPFS_H
 

vfs/gc.c

@@ -20,6 +20,17 @@
    License along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.  */
 
+/**
+ * \file
+ * \brief Source: Virtual File System: garbage collection code
+ * \author Miguel de Icaza
+ * \author Jakub Jelinek
+ * \author Pavel Machek
+ * \author Pavel Roskin
+ * \date 1995, 1998, 2003
+ */
+
+
 #include <config.h>
 
 #include <stdio.h>

vfs/gc.h

@@ -1,3 +1,9 @@
+
+/**
+ * \file
+ * \brief Header: Virtual File System: garbage collection code
+ */
+
 #ifndef MC_VFS_GC_H
 #define MC_VFS_GC_H
 

vfs/local.c

@@ -1,3 +1,9 @@
+
+/**
+ * \file
+ * \brief Source: local FS
+ */
+
 #include <config.h>
 #include <errno.h>
 #include <sys/types.h>
@@ -13,11 +19,12 @@
 #include "vfs.h"
 #include "local.h"
 
-/* Note: Some of this functions are not static. This has rather good
+/**
+ * Note: Some of this functions are not static. This has rather good
  * reason: exactly same functions would have to appear in sfs.c. This
  * saves both computer's memory and my work.  <pavel@ucw.cz>
- * */
-    
+ */
+
 static struct vfs_class vfs_local_ops;
 
 static void *