summaryrefslogtreecommitdiffstats
path: root/examples/dirview/dirview.doc
diff options
context:
space:
mode:
Diffstat (limited to 'examples/dirview/dirview.doc')
-rw-r--r--examples/dirview/dirview.doc35
1 files changed, 35 insertions, 0 deletions
diff --git a/examples/dirview/dirview.doc b/examples/dirview/dirview.doc
new file mode 100644
index 000000000..82a599996
--- /dev/null
+++ b/examples/dirview/dirview.doc
@@ -0,0 +1,35 @@
+
+/*
+*/
+/*! \page dirview-example.html
+
+ \ingroup examples
+ \title A Directory Browser
+
+ This example program demonstrates how to use a listview and
+ listview items to build a multi-column hierarchical, memory- and
+ CPU-efficient directory browser. It also demonstrates how to use
+ Drag&Drop in a listview.
+
+ <hr>
+
+ Header file:
+
+ \include dirview/dirview.h
+
+ <hr>
+
+ And here is the main implementation file. Note the way the program
+ scans subdirectories only when it has to. This allows the program
+ to handle very large file systems efficiently. The same technique
+ can be used in any other trees.
+
+ \include dirview/dirview.cpp
+
+ <hr>
+
+ Main:
+
+ \include dirview/main.cpp
+*/
+