doc updates
authorMiklos Szeredi <miklos@szeredi.hu>
Tue, 16 Oct 2007 14:25:08 +0000 (14:25 +0000)
committerMiklos Szeredi <miklos@szeredi.hu>
Tue, 16 Oct 2007 14:25:08 +0000 (14:25 +0000)
include/fuse.h
include/fuse_common.h
include/fuse_lowlevel.h
include/fuse_opt.h

index dc0975a7292926252b7641900cf464361c2ff289..22ec664689e8f33f6ad4093a02c3f025be2c859f 100644 (file)
@@ -9,12 +9,15 @@
 #ifndef _FUSE_H_
 #define _FUSE_H_
 
-/* This file defines the library interface of FUSE */
-
-/* IMPORTANT: you should define FUSE_USE_VERSION before including this
-   header.  To use the newest API define it to 26 (recommended for any
-   new application), to use the old API define it to 21 (default) 22
-   or 25, to use the even older 1.X API define it to 11. */
+/** @file
+ *
+ * This file defines the library interface of FUSE
+ *
+ * IMPORTANT: you should define FUSE_USE_VERSION before including this
+ * header.  To use the newest API define it to 26 (recommended for any
+ * new application), to use the old API define it to 21 (default) 22
+ * or 25, to use the even older 1.X API define it to 11.
+ */
 
 #ifndef FUSE_USE_VERSION
 #define FUSE_USE_VERSION 21
@@ -443,7 +446,7 @@ struct fuse_context {
     void *private_data;
 };
 
-/*
+/**
  * Main function of FUSE.
  *
  * This is for the lazy.  This is all that has to be called from the
index 384bd00146a20e085f890e8440ef926afee8c255..d4f3552369d51ba753b1f03da79eb816ed6982b2 100644 (file)
@@ -6,6 +6,8 @@
     See the file COPYING.LIB.
 */
 
+/** @file */
+
 #if !defined(_FUSE_H_) && !defined(_FUSE_LOWLEVEL_H_)
 #error "Never include <fuse_common.h> directly; use <fuse.h> or <fuse_lowlevel.h instead."
 #endif
index b55eeb23199f29bdcd634fe8fb6c80ac5eddeabc..0d97b697bf4e33f522fad3b81412b264121cd7f6 100644 (file)
@@ -9,14 +9,15 @@
 #ifndef _FUSE_LOWLEVEL_H_
 #define _FUSE_LOWLEVEL_H_
 
-/* =========================================================== *
- * Low level API                                               *
- * =========================================================== */
-
-/* IMPORTANT: you should define FUSE_USE_VERSION before including this
-   header.  To use the newest API define it to 26 (recommended for any
-   new application), to use the old API define it to 24 (default) or
-   25 */
+/** @file
+ *
+ * Low level API
+ *
+ * IMPORTANT: you should define FUSE_USE_VERSION before including this
+ * header.  To use the newest API define it to 26 (recommended for any
+ * new application), to use the old API define it to 24 (default) or
+ * 25
+ */
 
 #ifndef FUSE_USE_VERSION
 #define FUSE_USE_VERSION 24
index fbf502f53a642c546d53e4a27d63b54f261a0bf0..6534509833f09e0b232f148f9d73b5404f89d02f 100644 (file)
@@ -9,7 +9,10 @@
 #ifndef _FUSE_OPT_H_
 #define _FUSE_OPT_H_
 
-/* This file defines the option parsing interface of FUSE */
+/** @file
+ *
+ * This file defines the option parsing interface of FUSE
+ */
 
 #ifdef __cplusplus
 extern "C" {