Fix doxygen warnings. (#600)

Some parameters were undocumented, and @file does not mean to expand current file name.

diff --git a/example/invalidate_path.c b/example/invalidate_path.c
index 61ec351217f1a41b5a0865e2a196985fbf57cd90..9159b2fd55e73fa20864949c820d8b7d6dcdd23f 100644 (file)
--- a/example/invalidate_path.c
+++ b/example/invalidate_path.c
@@ -19,10 +19,10 @@
  *
  * ## Compilation ##
  *
- *     gcc -Wall @file `pkg-config fuse3 --cflags --libs` -o invalidate_path
+ *     gcc -Wall invalidate_path.c `pkg-config fuse3 --cflags --libs` -o invalidate_path
  *
  * ## Source code ##
- * \include @file
+ * \include invalidate_path.c
  */
 
 #define FUSE_USE_VERSION 34

diff --git a/example/printcap.c b/example/printcap.c
index bf058f5dd34f947c75583d0ec5e05f6668de4ed8..472a59760ad0f7aa4f569259f4078d995b83369f 100644 (file)
--- a/example/printcap.c
+++ b/example/printcap.c
@@ -16,7 +16,7 @@
  *     gcc -Wall printcap.c `pkg-config fuse3 --cflags --libs` -o printcap
  *
  * ## Source code ##
- * \include @file
+ * \include printcap.c
  */
 
 #define FUSE_USE_VERSION 31

diff --git a/include/fuse.h b/include/fuse.h
index 0e03a76b41e3e8b839847157ccba0ca06e9b4a83..9e6c63361ce6106ee2efb996d54521a39c9c1fc2 100644 (file)
--- a/include/fuse.h
+++ b/include/fuse.h
@@ -51,6 +51,9 @@ enum fuse_readdir_flags {
        FUSE_READDIR_PLUS = (1 << 0)
 };
 
+/**
+ * Readdir flags, passed to fuse_fill_dir_t callback.
+ */
 enum fuse_fill_dir_flags {
        /**
         * "Plus" mode: all file attributes are valid
@@ -74,7 +77,7 @@ enum fuse_fill_dir_flags {
  * 
  * @param buf the buffer passed to the readdir() operation
  * @param name the file name of the directory entry
- * @param stat file attributes, can be NULL
+ * @param stbuf file attributes, can be NULL
  * @param off offset of the next entry or zero
  * @param flags fill flags
  * @return 1 if buffer is full, zero otherwise
@@ -664,6 +667,10 @@ struct fuse_operations {
         */
        int (*bmap) (const char *, size_t blocksize, uint64_t *idx);
 
+#if FUSE_USE_VERSION < 35
+       int (*ioctl) (const char *, int cmd, void *arg,
+                     struct fuse_file_info *, unsigned int flags, void *data);
+#else
        /**
         * Ioctl
         *
@@ -680,10 +687,6 @@ struct fuse_operations {
         * Note : the unsigned long request submitted by the application
         * is truncated to 32 bits.
         */
-#if FUSE_USE_VERSION < 35
-       int (*ioctl) (const char *, int cmd, void *arg,
-                     struct fuse_file_info *, unsigned int flags, void *data);
-#else
        int (*ioctl) (const char *, unsigned int cmd, void *arg,
                      struct fuse_file_info *, unsigned int flags, void *data);
 #endif
@@ -984,6 +987,10 @@ int fuse_loop(struct fuse *f);
  */
 void fuse_exit(struct fuse *f);
 
+#if FUSE_USE_VERSION < 32
+int fuse_loop_mt_31(struct fuse *f, int clone_fd);
+#define fuse_loop_mt(f, clone_fd) fuse_loop_mt_31(f, clone_fd)
+#else
 /**
  * FUSE event loop with multiple threads
  *
@@ -1015,10 +1022,6 @@ void fuse_exit(struct fuse *f);
  *
  * See also: fuse_loop()
  */
-#if FUSE_USE_VERSION < 32
-int fuse_loop_mt_31(struct fuse *f, int clone_fd);
-#define fuse_loop_mt(f, clone_fd) fuse_loop_mt_31(f, clone_fd)
-#else
 int fuse_loop_mt(struct fuse *f, struct fuse_loop_config *config);
 #endif
 

diff --git a/include/fuse_lowlevel.h b/include/fuse_lowlevel.h
index 95737eb0c4cbff46d7aae1cd7222c77dbc581524..2a7db93b182d01512dd927e772fd202ba86d4fff 100644 (file)
--- a/include/fuse_lowlevel.h
+++ b/include/fuse_lowlevel.h
@@ -1967,6 +1967,11 @@ int fuse_session_mount(struct fuse_session *se, const char *mountpoint);
  */
 int fuse_session_loop(struct fuse_session *se);
 
+#if FUSE_USE_VERSION < 32
+int fuse_session_loop_mt_31(struct fuse_session *se, int clone_fd);
+#define fuse_session_loop_mt(se, clone_fd) fuse_session_loop_mt_31(se, clone_fd)
+#else
+#if (!defined(__UCLIBC__) && !defined(__APPLE__))
 /**
  * Enter a multi-threaded event loop.
  *
@@ -1978,11 +1983,6 @@ int fuse_session_loop(struct fuse_session *se);
  * @param config session loop configuration 
  * @return see fuse_session_loop()
  */
-#if FUSE_USE_VERSION < 32
-int fuse_session_loop_mt_31(struct fuse_session *se, int clone_fd);
-#define fuse_session_loop_mt(se, clone_fd) fuse_session_loop_mt_31(se, clone_fd)
-#else
-#if (!defined(__UCLIBC__) && !defined(__APPLE__))
 int fuse_session_loop_mt(struct fuse_session *se, struct fuse_loop_config *config);
 #else
 int fuse_session_loop_mt_32(struct fuse_session *se, struct fuse_loop_config *config);