aboutsummaryrefslogtreecommitdiff
path: root/example/hello.c
diff options
context:
space:
mode:
authorGravatar Nikolaus Rath <Nikolaus@rath.org>2016-10-28 20:44:39 -0700
committerGravatar Nikolaus Rath <Nikolaus@rath.org>2016-10-28 20:44:39 -0700
commit7983414b33b43e76fc9766067b27060772150dbf (patch)
tree5adcac69cbe50affc7b9ff2185743dd9e62cada0 /example/hello.c
parentb27033bc35dcef9d4a65788bd613473add3e3887 (diff)
Clean-up doxygen documentation
Fixes: #81.
Diffstat (limited to 'example/hello.c')
-rw-r--r--example/hello.c24
1 files changed, 5 insertions, 19 deletions
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 <stddef.h>
#include <assert.h>
-/**
+/*
* Command line options
*
* We can't set default values for the char* fields here because