summaryrefslogtreecommitdiff
path: root/doc/source/dev/examples/doxy_func.h
diff options
context:
space:
mode:
authorSayantika Banik <sayantikabanik122@gmail.com>2021-09-08 06:21:36 +0000
committerSayantika Banik <sayantikabanik122@gmail.com>2021-09-08 06:21:36 +0000
commit879b3b4798975c7c0c49cef6ece3563c5f2daaeb (patch)
treee102f2222f1557d9b4f8b1a3e9484ca59b8ad954 /doc/source/dev/examples/doxy_func.h
parent9680d760cdb08cc54c18657c77269853670f17e9 (diff)
parent17c3a6b414a3e642abeb116ff71e97f9b6f2aab5 (diff)
downloadnumpy-879b3b4798975c7c0c49cef6ece3563c5f2daaeb.tar.gz
Merge branch 'main' of https://github.com/sayantikabanik/numpy
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);