summaryrefslogtreecommitdiffstats
path: root/examples/xml/outliner/outliner.doc
diff options
context:
space:
mode:
Diffstat (limited to 'examples/xml/outliner/outliner.doc')
-rw-r--r--examples/xml/outliner/outliner.doc40
1 files changed, 40 insertions, 0 deletions
diff --git a/examples/xml/outliner/outliner.doc b/examples/xml/outliner/outliner.doc
new file mode 100644
index 000000000..c21043dd6
--- /dev/null
+++ b/examples/xml/outliner/outliner.doc
@@ -0,0 +1,40 @@
+/*
+*/
+
+/*! \page outliner-example.html
+
+ \ingroup xml-examples
+
+ \title Outliner to show use of DOM
+
+ This example presents a small outliner program to show the basic usage of
+ the \link xml.html#dom DOM classes \endlink. The format of the outlines
+ is the OPML format as described in http://www.opml.org/spec.
+
+ This example shows how to load a DOM tree from an XML file and how to
+ traverse it.
+
+ <hr>
+
+ Sample XML file (todos.opml):
+
+ \include xml/outliner/todos.opml
+
+ <hr>
+
+ Header file (outlinetree.h):
+
+ \include xml/outliner/outlinetree.h
+
+ <hr>
+
+ Implementation (outlinetree.cpp):
+
+ \include xml/outliner/outlinetree.cpp
+
+ <hr>
+
+ Main (main.cpp):
+
+ \include xml/outliner/main.cpp
+*/