diff options
| author | Miklos Szeredi <miklos@szeredi.hu> | 2007-10-16 14:25:08 +0000 |
|---|---|---|
| committer | Miklos Szeredi <miklos@szeredi.hu> | 2007-10-16 14:25:08 +0000 |
| commit | b41c45be83d625097052b5362704f210795c6220 (patch) | |
| tree | 0b67dbea565ecffa400496269661216d6b6a1dce | |
| parent | 68a9657062996e40c6d59746dd760374403e07e4 (diff) | |
| download | fuse-b41c45be83d625097052b5362704f210795c6220.tar.gz | |
doc updates
| -rw-r--r-- | include/fuse.h | 17 | ||||
| -rw-r--r-- | include/fuse_common.h | 2 | ||||
| -rw-r--r-- | include/fuse_lowlevel.h | 17 | ||||
| -rw-r--r-- | include/fuse_opt.h | 5 |
4 files changed, 25 insertions, 16 deletions
diff --git a/include/fuse.h b/include/fuse.h index dc0975a..22ec664 100644 --- a/include/fuse.h +++ b/include/fuse.h @@ -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 diff --git a/include/fuse_common.h b/include/fuse_common.h index 384bd00..d4f3552 100644 --- a/include/fuse_common.h +++ b/include/fuse_common.h @@ -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 diff --git a/include/fuse_lowlevel.h b/include/fuse_lowlevel.h index b55eeb2..0d97b69 100644 --- a/include/fuse_lowlevel.h +++ b/include/fuse_lowlevel.h @@ -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 diff --git a/include/fuse_opt.h b/include/fuse_opt.h index fbf502f..6534509 100644 --- a/include/fuse_opt.h +++ b/include/fuse_opt.h @@ -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" { |