From 7983414b33b43e76fc9766067b27060772150dbf Mon Sep 17 00:00:00 2001 From: Nikolaus Rath Date: Fri, 28 Oct 2016 20:44:39 -0700 Subject: Clean-up doxygen documentation Fixes: #81. --- example/cuse.c | 5 ++--- example/cuse_client.c | 7 +++---- example/hello.c | 24 +++++------------------- example/hello_ll.c | 29 ++++------------------------- example/ioctl.c | 6 +++--- example/ioctl_client.c | 7 +++---- example/notify_inval_entry.c | 5 ++--- example/notify_inval_inode.c | 5 ++--- example/notify_store_retrieve.c | 5 ++--- example/passthrough.c | 7 +++---- example/passthrough_fh.c | 7 +++---- example/passthrough_ll.c | 7 +++---- example/poll.c | 7 +++---- example/poll_client.c | 9 +++------ 14 files changed, 41 insertions(+), 89 deletions(-) (limited to 'example') diff --git a/example/cuse.c b/example/cuse.c index 443d308..e5514e9 100644 --- a/example/cuse.c +++ b/example/cuse.c @@ -9,7 +9,6 @@ */ /** @file - * @tableofcontents * * This example demonstrates how to implement a character device in * userspace ("CUSE"). This is only allowed for root. The character @@ -23,11 +22,11 @@ * You should now have a new /dev/mydevice character device. To "unmount" it, * kill the "cuse" process. * - * \section section_compile compiling this example + * To compile this example, run * * gcc -Wall cuse.c `pkg-config fuse3 --cflags --libs` -o cuse * - * \section section_source the complete source + * ## Source code ## * \include cuse.c */ diff --git a/example/cuse_client.c b/example/cuse_client.c index 3e47635..cc85c20 100755 --- a/example/cuse_client.c +++ b/example/cuse_client.c @@ -8,7 +8,6 @@ */ /** @file - * @tableofcontents * * This program tests the cuse.c example file system. * @@ -29,11 +28,11 @@ * hello * transferred 6 bytes (6 -> 6) * - * \section section_compile compiling this example + * Compiling this example * - * gcc -Wall cuse_client.c -o cuse_client + * gcc -Wall cuse_client.c -o cuse_client * - * \section section_source the complete source + * ## Source Code ## * \include cuse_client.c */ diff --git a/example/hello.c b/example/hello.c index b7ce45b..67932e0 100644 --- a/example/hello.c +++ b/example/hello.c @@ -8,27 +8,13 @@ /** @file * - * hello.c - minimal FUSE example featuring fuse_main usage + * minimal example filesystem using high-level API * - * \section section_compile compiling this example + * Compile with: * - * gcc -Wall hello.c `pkg-config fuse3 --cflags --libs` -o hello + * gcc -Wall hello.c `pkg-config fuse3 --cflags --libs` -o hello * - * \section section_usage usage - \verbatim - % mkdir mnt - % ./hello mnt # program will vanish into the background - % ls -la mnt - total 4 - drwxr-xr-x 2 root root 0 Jan 1 1970 ./ - drwxrwx--- 1 root vboxsf 4096 Jun 16 23:12 ../ - -r--r--r-- 1 root root 13 Jan 1 1970 hello - % cat mnt/hello - Hello World! - % fusermount -u mnt - \endverbatim - * - * \section section_source the complete source + * ## Source code ## * \include hello.c */ @@ -45,7 +31,7 @@ #include #include -/** +/* * Command line options * * We can't set default values for the char* fields here because diff --git a/example/hello_ll.c b/example/hello_ll.c index d673a5d..da3a4fc 100644 --- a/example/hello_ll.c +++ b/example/hello_ll.c @@ -8,32 +8,13 @@ /** @file * - * hello_ll.c - fuse low level functionality + * minimal example filesystem using low-level API * - * unlike hello.c this example will stay in the foreground. it also replaced - * the convenience function fuse_main(..) with a more low level approach. + * Compile with: * - * \section section_compile compiling this example + * gcc -Wall hello_ll.c `pkg-config fuse3 --cflags --libs` -o hello_ll * - * gcc -Wall hello_ll.c `pkg-config fuse3 --cflags --libs` -o hello_ll - * - * \section section_usage usage - \verbatim - % mkdir mnt - % ./hello_ll mnt # program will wait in foreground until you press CTRL+C - in a different shell do: - % ls -la mnt - total 4 - drwxr-xr-x 2 root root 0 Jan 1 1970 ./ - drwxrwx--- 1 root vboxsf 4096 Jun 16 23:12 ../ - -r--r--r-- 1 root root 13 Jan 1 1970 hello - % cat mnt/hello - Hello World! - finally either press ctrl+c or do: - % fusermount -u mnt - \endverbatim - * - * \section section_source the complete source + * ## Source code ## * \include hello_ll.c */ @@ -182,7 +163,6 @@ static struct fuse_lowlevel_ops hello_ll_oper = { .read = hello_ll_read, }; -/*! [doxygen_fuse_lowlevel_usage] */ int main(int argc, char *argv[]) { struct fuse_args args = FUSE_ARGS_INIT(argc, argv); @@ -235,4 +215,3 @@ err_out1: return ret ? 1 : 0; } -/*! [doxygen_fuse_lowlevel_usage] */ diff --git a/example/ioctl.c b/example/ioctl.c index 0a4c14d..734765d 100644 --- a/example/ioctl.c +++ b/example/ioctl.c @@ -14,11 +14,11 @@ * process (a restricted set of) ioctls. It can be tested with the * ioctl_client.c program. * - * \section section_compile compiling this example + * Compile with: * - * gcc -Wall ioctl.c `pkg-config fuse3 --cflags --libs` -o ioctl + * gcc -Wall ioctl.c `pkg-config fuse3 --cflags --libs` -o ioctl * - * \section section_source the complete source + * ## Source code ## * \include ioctl.c */ diff --git a/example/ioctl_client.c b/example/ioctl_client.c index 83ede65..a58a897 100644 --- a/example/ioctl_client.c +++ b/example/ioctl_client.c @@ -10,15 +10,14 @@ */ /** @file - * @tableofcontents * * This program tests the ioctl.c example file systsem. * - * \section section_compile compiling this example + * Compile with: * - * gcc -Wall ioctl_client.c -o ioctl_client + * gcc -Wall ioctl_client.c -o ioctl_client * - * \section section_source the complete source + * ## Source code ## * \include ioctl_client.c */ diff --git a/example/notify_inval_entry.c b/example/notify_inval_entry.c index 7c33dc4..30192d1 100644 --- a/example/notify_inval_entry.c +++ b/example/notify_inval_entry.c @@ -7,7 +7,6 @@ */ /** @file - * @tableofcontents * * This example implements a file system with a single file whose * file name changes dynamically to reflect the current time. @@ -65,11 +64,11 @@ * $ sleep 1; stat mnt/$file * stat: cannot stat ‘mnt/Time_is_20h_42m_11s’: No such file or directory * - * \section section_compile compiling this example + * ## Compilation ## * * gcc -Wall notify_inval_entry.c `pkg-config fuse3 --cflags --libs` -o notify_inval_entry * - * \section section_source the complete source + * ## Source code ## * \include notify_inval_entry.c */ diff --git a/example/notify_inval_inode.c b/example/notify_inval_inode.c index 934be60..9bb9316 100644 --- a/example/notify_inval_inode.c +++ b/example/notify_inval_inode.c @@ -7,7 +7,6 @@ */ /** @file - * @tableofcontents * * This example implements a file system with a single file whose * contents change dynamically: it always contains the current time. @@ -51,11 +50,11 @@ * The current time is 15:58:43 * The current time is 15:58:44 * - * \section section_compile compiling this example + * ## Compilation ## * * gcc -Wall notify_inval_inode.c `pkg-config fuse3 --cflags --libs` -o notify_inval_inode * - * \section section_source the complete source + * ## Source code ## * \include notify_inval_inode.c */ diff --git a/example/notify_store_retrieve.c b/example/notify_store_retrieve.c index 6c8678a..440a7f8 100644 --- a/example/notify_store_retrieve.c +++ b/example/notify_store_retrieve.c @@ -7,7 +7,6 @@ */ /** @file - * @tableofcontents * * This example implements a file system with a single file whose * contents change dynamically: it always contains the current time. @@ -50,11 +49,11 @@ * The current time is 15:58:43 * The current time is 15:58:44 * - * \section section_compile compiling this example + * ## Compilation ## * * gcc -Wall notify_store_retrieve.c `pkg-config fuse3 --cflags --libs` -o notify_store_retrieve * - * \section section_source the complete source + * ## Source code ## * \include notify_store_retrieve.c */ diff --git a/example/passthrough.c b/example/passthrough.c index 4034327..fbc1597 100644 --- a/example/passthrough.c +++ b/example/passthrough.c @@ -8,18 +8,17 @@ */ /** @file - * @tableofcontents * * This file system mirrors the existing file system hierarchy of the * system, starting at the root file system. This is implemented by * just "passing through" all requests to the corresponding user-space * libc functions. It's performance is terrible. * - * \section section_compile compiling this example + * Compile with * - * gcc -Wall passthrough.c `pkg-config fuse3 --cflags --libs` -o passthrough + * gcc -Wall passthrough.c `pkg-config fuse3 --cflags --libs` -o passthrough * - * \section section_source the complete source + * ## Source code ## * \include passthrough.c */ diff --git a/example/passthrough_fh.c b/example/passthrough_fh.c index 781f717..c807d75 100644 --- a/example/passthrough_fh.c +++ b/example/passthrough_fh.c @@ -8,7 +8,6 @@ */ /** @file - * @tableofcontents * * This file system mirrors the existing file system hierarchy of the * system, starting at the root file system. This is implemented by @@ -16,11 +15,11 @@ * libc functions. This implementation is a little more sophisticated * than the one in passthrough.c, so performance is not quite as bad. * - * \section section_compile compiling this example + * Compile with: * - * gcc -Wall passthrough_fh.c `pkg-config fuse3 --cflags --libs` -lulockmgr -o passthrough_fh + * gcc -Wall passthrough_fh.c `pkg-config fuse3 --cflags --libs` -lulockmgr -o passthrough_fh * - * \section section_source the complete source + * ## Source code ## * \include passthrough_fh.c */ diff --git a/example/passthrough_ll.c b/example/passthrough_ll.c index dc5e10a..995026e 100644 --- a/example/passthrough_ll.c +++ b/example/passthrough_ll.c @@ -7,7 +7,6 @@ */ /** @file - * @tableofcontents * * This file system mirrors the existing file system hierarchy of the * system, starting at the root file system. This is implemented by @@ -16,11 +15,11 @@ * this implementation ises the low-level API. Its performance should * be the least bad among the three. * - * \section section_compile compiling this example + * Compile with: * - * gcc -Wall passthrough_ll.c `pkg-config fuse3 --cflags --libs` -o passthrough_ll + * gcc -Wall passthrough_ll.c `pkg-config fuse3 --cflags --libs` -o passthrough_ll * - * \section section_source the complete source + * ## Source code ## * \include passthrough_ll.c */ diff --git a/example/poll.c b/example/poll.c index 10175a3..36a1371 100644 --- a/example/poll.c +++ b/example/poll.c @@ -8,17 +8,16 @@ */ /** @file - * @tableofcontents * * This example illustrates how to write a FUSE file system that * supports polling for changes that don't come through the kernel. It * can be tested with the poll_client.c program. * - * \section section_compile compiling this example + * Compile with: * - * gcc -Wall poll.c `pkg-config fuse3 --cflags --libs` -o poll + * gcc -Wall poll.c `pkg-config fuse3 --cflags --libs` -o poll * - * \section section_source the complete source + * ## Source code ## * \include poll.c */ diff --git a/example/poll_client.c b/example/poll_client.c index 5c04fea..1d7a153 100644 --- a/example/poll_client.c +++ b/example/poll_client.c @@ -8,17 +8,14 @@ */ /** @file - * @tableofcontents - * - * poll_client.c * * This program tests the poll.c example file systsem. * - * \section section_compile compiling this example + * Compile with: * - * gcc -Wall poll_client.c -o poll_client + * gcc -Wall poll_client.c -o poll_client * - * \section section_source the complete source + * ## Source code ## * \include poll_client.c */ -- cgit v1.2.3