summaryrefslogtreecommitdiffstats
path: root/examples/regexptester/regexptester.doc
diff options
context:
space:
mode:
Diffstat (limited to 'examples/regexptester/regexptester.doc')
-rw-r--r--examples/regexptester/regexptester.doc35
1 files changed, 35 insertions, 0 deletions
diff --git a/examples/regexptester/regexptester.doc b/examples/regexptester/regexptester.doc
new file mode 100644
index 0000000..81f7cb4
--- /dev/null
+++ b/examples/regexptester/regexptester.doc
@@ -0,0 +1,35 @@
+/*!
+ \page regexptester-example.html
+
+ \ingroup examples
+
+ \title A Small Application for Testing Regular Expressions
+
+ Regular expressions can sometimes be tricky to get right,
+ especially those that use the * quantifier. This application lets
+ you type in a regexp (without doubling the backslashes) and some
+ test text, and to execute the regexp and see the results. If you
+ click the Copy button the regexp will be copied to the clipboard
+ (with the backslashes doubled, ready for you to paste into your
+ program). Previous regexps and test texts are remembered
+ throughout the session and can be accessed by dropping down the
+ comboboxes.
+
+ <hr>
+
+ Header file:
+
+ \include regexptester/regexptester.h
+
+ <hr>
+
+ Implementation:
+
+ \include regexptester/regexptester.cpp
+
+ <hr>
+
+ Main:
+
+ \include regexptester/main.cpp
+*/