summaryrefslogtreecommitdiff
path: root/doc/source/dev/examples/doxy_rst.h
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/dev/examples/doxy_rst.h')
-rw-r--r--doc/source/dev/examples/doxy_rst.h15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/source/dev/examples/doxy_rst.h b/doc/source/dev/examples/doxy_rst.h
new file mode 100644
index 000000000..6ab4a0775
--- /dev/null
+++ b/doc/source/dev/examples/doxy_rst.h
@@ -0,0 +1,15 @@
+/**
+ * A comment block contains reST markup.
+ * @rst
+ * .. note::
+ *
+ * Thanks to Breathe_, we were able to bring it to Doxygen_
+ *
+ * Some code example::
+ *
+ * int example(int x) {
+ * return x * 2;
+ * }
+ * @endrst
+ */
+void doxy_reST_example(void);