summaryrefslogtreecommitdiffstats
path: root/examples/example.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'examples/example.cpp')
-rw-r--r--examples/example.cpp19
1 files changed, 19 insertions, 0 deletions
diff --git a/examples/example.cpp b/examples/example.cpp
new file mode 100644
index 0000000..230d6ec
--- /dev/null
+++ b/examples/example.cpp
@@ -0,0 +1,19 @@
+/** A Test class.
+ * More details about this class.
+ */
+
+class Test
+{
+ public:
+ /** 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.
+ */