summaryrefslogtreecommitdiffstats
path: root/examples/biff/biff.doc
diff options
context:
space:
mode:
Diffstat (limited to 'examples/biff/biff.doc')
-rw-r--r--examples/biff/biff.doc31
1 files changed, 31 insertions, 0 deletions
diff --git a/examples/biff/biff.doc b/examples/biff/biff.doc
new file mode 100644
index 000000000..d16216825
--- /dev/null
+++ b/examples/biff/biff.doc
@@ -0,0 +1,31 @@
+/*
+*/
+/*! \page biff-example.html
+
+ \ingroup examples
+ \title Biff (UNIX only)
+
+ Biff is a simple graphical program to indicate whether there is new
+ mail; it looks exactly like xbiff but is much shorter.
+
+ <hr>
+
+ Header file:
+
+ \include biff/biff.h
+
+ <hr>
+
+ \e biff.cpp implements this custom widget. Note in particular
+ how two images (\e hasmail_bmp_data and \e nomail_bmp_data, both from
+ \e bmp.cpp) are included into the executable.
+
+ \include biff/biff.cpp
+
+ <hr>
+
+ Main:
+
+ \include biff/main.cpp
+*/
+