diff options
author | Nikolaus Rath <Nikolaus@rath.org> | 2016-10-28 20:44:39 -0700 |
---|---|---|
committer | Nikolaus Rath <Nikolaus@rath.org> | 2016-10-28 20:44:39 -0700 |
commit | 7983414b33b43e76fc9766067b27060772150dbf (patch) | |
tree | 5adcac69cbe50affc7b9ff2185743dd9e62cada0 /include | |
parent | b27033bc35dcef9d4a65788bd613473add3e3887 (diff) |
Clean-up doxygen documentation
Fixes: #81.
Diffstat (limited to 'include')
-rw-r--r-- | include/fuse.h | 8 | ||||
-rw-r--r-- | include/fuse_common.h | 5 | ||||
-rw-r--r-- | include/fuse_lowlevel.h | 7 |
3 files changed, 7 insertions, 13 deletions
diff --git a/include/fuse.h b/include/fuse.h index 4e7d46e..45c84ad 100644 --- a/include/fuse.h +++ b/include/fuse.h @@ -1079,12 +1079,12 @@ typedef struct fuse_fs *(*fuse_module_factory_t)(struct fuse_args *args, /** * Register filesystem module * - * If the "-omodules=@name_:..." option is present, filesystem - * objects are created and pushed onto the stack with the @factory_ + * If the "-omodules=*name*_:..." option is present, filesystem + * objects are created and pushed onto the stack with the *factory_* * function. * - * @name_ the name of this filesystem module - * @factory_ the factory function for this filesystem module + * @param name_ the name of this filesystem module + * @param factory_ the factory function for this filesystem module */ #define FUSE_REGISTER_MODULE(name_, factory_) \ fuse_module_factory_t fuse_module_ ## name_ ## _factory = factory_; diff --git a/include/fuse_common.h b/include/fuse_common.h index 5840956..44b0634 100644 --- a/include/fuse_common.h +++ b/include/fuse_common.h @@ -554,9 +554,8 @@ ssize_t fuse_buf_copy(struct fuse_bufvec *dst, struct fuse_bufvec *src, * Stores session in a global variable. May only be called once per * process until fuse_remove_signal_handlers() is called. * - * Once either of the POSIX signals arrives, the exit_handler() in - * fuse_signals.c is called: - * \snippet fuse_signals.c doxygen_exit_handler + * Once either of the POSIX signals arrives, the fuse_session_exit() + * is called. * * @param se the session to exit * @return 0 on success, -1 on failure diff --git a/include/fuse_lowlevel.h b/include/fuse_lowlevel.h index aa59ec8..0ae7734 100644 --- a/include/fuse_lowlevel.h +++ b/include/fuse_lowlevel.h @@ -876,7 +876,7 @@ struct fuse_lowlevel_ops { * * Note: For unrestricted ioctls (not allowed for FUSE * servers), data in and out areas can be discovered by giving - * iovs and setting FUSE_IOCTL_RETRY in @flags. For + * iovs and setting FUSE_IOCTL_RETRY in *flags*. For * restricted ioctls, kernel prepares in/out data area * according to the information encoded in cmd. * @@ -1675,9 +1675,6 @@ int fuse_parse_cmdline(struct fuse_args *args, * @param userdata user data * * @return the fuse session on success, NULL on failure - * - * Example: See hello_ll.c: - * \snippet hello_ll.c doxygen_fuse_lowlevel_usage **/ struct fuse_session *fuse_session_new(struct fuse_args *args, const struct fuse_lowlevel_ops *op, @@ -1782,7 +1779,6 @@ int fuse_session_fd(struct fuse_session *se); * * @param se the session * @param buf the fuse_buf containing the request - * @param ch channel on which the request was received */ void fuse_session_process_buf(struct fuse_session *se, const struct fuse_buf *buf); @@ -1796,7 +1792,6 @@ void fuse_session_process_buf(struct fuse_session *se, * * @param se the session * @param buf the fuse_buf to store the request in - * @param ch the channel * @return the actual size of the raw request, or -errno on error */ int fuse_session_receive_buf(struct fuse_session *se, struct fuse_buf *buf); |