Re-order declarations to reflect typical order of use

1 files changed, 73 insertions, 71 deletions

diff --git a/include/fuse_lowlevel.h b/include/fuse_lowlevel.h
index e652058..6b2fa3f 100644
--- a/include/fuse_lowlevel.h
+++ b/include/fuse_lowlevel.h
@@ -1569,10 +1569,29 @@ void fuse_req_interrupt_func(fuse_req_t req, fuse_interrupt_func_t func,
 int fuse_req_interrupted(fuse_req_t req);
 
 /* ----------------------------------------------------------- *
- * Filesystem setup					       *
+ * Filesystem setup & teardown                                 *
  * ----------------------------------------------------------- */
 
 /**
+ * Create a FUSE mountpoint
+ *
+ * Returns a control file descriptor suitable for passing to
+ * fuse_new(). Unknown parameters in `args` are passed through
+ * unchanged. Known parameters (with the exception of --help and
+ * --version) are removed from `args`.
+ *
+ * If the --help or --version parameters are specified, the function
+ * prints the requested information to stdout and returns a valid
+ * pointer. However, it does not actually perform the mount.
+ *
+ * @param mountpoint the mount point path
+ * @param args argument vector
+ * @return the communication channel on success, NULL on failure
+ */
+struct fuse_chan *fuse_session_mount(const char *mountpoint,
+				     struct fuse_args *args);
+
+/**
  * Create a low level session
  *
  * Known parameters in `args` are removed. If there are any unknown
@@ -1595,10 +1614,6 @@ struct fuse_session *fuse_lowlevel_new(struct fuse_args *args,
 				       const struct fuse_lowlevel_ops *op,
 				       size_t op_size, void *userdata);
 
-/* ----------------------------------------------------------- *
- * Session interface					       *
- * ----------------------------------------------------------- */
-
 /**
  * Assign a channel to a session
  *
@@ -1610,54 +1625,24 @@ struct fuse_session *fuse_lowlevel_new(struct fuse_args *args,
 void fuse_session_add_chan(struct fuse_session *se, struct fuse_chan *ch);
 
 /**
- * Remove the channel from a session
- *
- * If the channel is not assigned to a session, then this is a no-op
- *
- * @param ch the channel to remove
- */
-void fuse_session_remove_chan(struct fuse_chan *ch);
-
-/**
- * Return channel assigned to the session
- *
- * @param se the session
- * @return the channel
- */
-struct fuse_chan *fuse_session_chan(struct fuse_session *se);
-
-/**
- * Process a raw request supplied in a generic buffer
- *
- * The fuse_buf may contain a memory buffer or a pipe file descriptor.
- *
- * @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, struct fuse_chan *ch);
-
-/**
- * Receive a raw request supplied in a generic buffer
+ * Enter a single threaded, blocking event loop.
  *
- * The fuse_buf supplied to this function contains a suitably allocated memory
- * buffer.  This may be overwritten with a file descriptor buffer.
+ * Using POSIX signals this event loop can be exited but the session
+ * needs to be configued by issuing:
+ *   fuse_set_signal_handlers() first.
  *
  * @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
+ * @return 0 on success, -1 on error
  */
-int fuse_session_receive_buf(struct fuse_session *se, struct fuse_buf *buf,
-			     struct fuse_chan *ch);
+int fuse_session_loop(struct fuse_session *se);
 
 /**
- * Destroy a session
+ * Enter a multi-threaded event loop
  *
  * @param se the session
+ * @return 0 on success, -1 on error
  */
-void fuse_session_destroy(struct fuse_session *se);
+int fuse_session_loop_mt(struct fuse_session *se);
 
 /**
  * Flag a session as terminated.
@@ -1686,57 +1671,74 @@ void fuse_session_reset(struct fuse_session *se);
 int fuse_session_exited(struct fuse_session *se);
 
 /**
- * Enter a single threaded, blocking event loop.
+ * Remove the channel from a session
  *
- * Using POSIX signals this event loop can be exited but the session
- * needs to be configued by issuing:
- *   fuse_set_signal_handlers() first.
+ * If the channel is not assigned to a session, then this is a no-op
  *
- * @param se the session
- * @return 0 on success, -1 on error
+ * @param ch the channel to remove
  */
-int fuse_session_loop(struct fuse_session *se);
+void fuse_session_remove_chan(struct fuse_chan *ch);
 
 /**
- * Enter a multi-threaded event loop
+ * Destroy a session
  *
  * @param se the session
- * @return 0 on success, -1 on error
  */
-int fuse_session_loop_mt(struct fuse_session *se);
+void fuse_session_destroy(struct fuse_session *se);
 
 /**
- * Create a FUSE mountpoint
+ * Umount a FUSE mountpoint
  *
- * Returns a control file descriptor suitable for passing to
- * fuse_new(). Unknown parameters in `args` are passed through
- * unchanged. Known parameters (with the exception of --help and
- * --version) are removed from `args`.
+ * @param mountpoint the mount point path
+ * @param ch the communication channel
+ */
+void fuse_session_unmount(const char *mountpoint, struct fuse_chan *ch);
+
+
+/* ----------------------------------------------------------- *
+ * Request processing (for custom event loops)                 *
+ * ----------------------------------------------------------- */
+
+/**
+ * Process a raw request supplied in a generic buffer
  *
- * If the --help or --version parameters are specified, the function
- * prints the requested information to stdout and returns a valid
- * pointer. However, it does not actually perform the mount.
+ * The fuse_buf may contain a memory buffer or a pipe file descriptor.
  *
- * @param mountpoint the mount point path
- * @param args argument vector
- * @return the communication channel on success, NULL on failure
+ * @param se the session
+ * @param buf the fuse_buf containing the request
+ * @param ch channel on which the request was received
  */
-struct fuse_chan *fuse_session_mount(const char *mountpoint,
-				     struct fuse_args *args);
+void fuse_session_process_buf(struct fuse_session *se,
+			      const struct fuse_buf *buf, struct fuse_chan *ch);
 
 /**
- * Umount a FUSE mountpoint
+ * Receive a raw request supplied in a generic buffer
  *
- * @param mountpoint the mount point path
- * @param ch the communication channel
+ * The fuse_buf supplied to this function contains a suitably allocated memory
+ * buffer.  This may be overwritten with a file descriptor buffer.
+ *
+ * @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
  */
-void fuse_session_unmount(const char *mountpoint, struct fuse_chan *ch);
+int fuse_session_receive_buf(struct fuse_session *se, struct fuse_buf *buf,
+			     struct fuse_chan *ch);
 
 /* ----------------------------------------------------------- *
  * Channel interface					       *
  * ----------------------------------------------------------- */
 
 /**
+ * Return channel assigned to the session
+ *
+ * @param se the session
+ * @return the channel
+ */
+struct fuse_chan *fuse_session_chan(struct fuse_session *se);
+
+
+/**
  * Obtain counted reference to the channel
  *
  * @param ch the channel