summaryrefslogtreecommitdiffstats
path: root/testing/025_example.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'testing/025_example.cpp')
-rw-r--r--testing/025_example.cpp26
1 files changed, 26 insertions, 0 deletions
diff --git a/testing/025_example.cpp b/testing/025_example.cpp
new file mode 100644
index 0000000..39736f8
--- /dev/null
+++ b/testing/025_example.cpp
@@ -0,0 +1,26 @@
+// objective: test the \example command
+// check: example_test_8cpp-example.xml
+// check: class_test.xml
+// config: EXAMPLE_PATH = .
+
+/** \brief A Test class.
+ *
+ * More details about this class.
+ */
+class Test
+{
+ public:
+ /** \brief An example member function.
+ *
+ * More details about this function.
+ */
+ void example();
+};
+
+void Test::example() {}
+
+/** \example example_test.cpp
+ * This is an example of how to use the Test class.
+ *
+ * More details about this example.
+ */