summaryrefslogtreecommitdiff
path: root/doc/source/dev/examples/doxy_func.h
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/dev/examples/doxy_func.h')
-rw-r--r--doc/source/dev/examples/doxy_func.h11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/source/dev/examples/doxy_func.h b/doc/source/dev/examples/doxy_func.h
new file mode 100644
index 000000000..792a9d1b7
--- /dev/null
+++ b/doc/source/dev/examples/doxy_func.h
@@ -0,0 +1,11 @@
+/**
+ * This a simple brief.
+ *
+ * And the details goes here.
+ * Multi lines are welcome.
+ *
+ * @param num leave a comment for parameter num.
+ * @param str leave a comment for the second parameter.
+ * @return leave a comment for the returned value.
+ */
+int doxy_javadoc_example(int num, const char *str);