summaryrefslogtreecommitdiff
path: root/examples/enum.h
diff options
context:
space:
mode:
Diffstat (limited to 'examples/enum.h')
-rw-r--r--examples/enum.h24
1 files changed, 24 insertions, 0 deletions
diff --git a/examples/enum.h b/examples/enum.h
new file mode 100644
index 0000000..4c54fab
--- /dev/null
+++ b/examples/enum.h
@@ -0,0 +1,24 @@
+class Test
+{
+ public:
+ enum TEnum { Val1, Val2 };
+
+ /*! Another enum, with inline docs */
+ enum AnotherEnum
+ {
+ V1, /*!< value 1 */
+ V2 /*!< value 2 */
+ };
+};
+
+/*! \class Test
+ * The class description.
+ */
+
+/*! \enum Test::TEnum
+ * A description of the enum type.
+ */
+
+/*! \var Test::TEnum Test::Val1
+ * The description of the first enum value.
+ */