From 241527a3cb287c1033b3a71a7cc14c40f22ec607 Mon Sep 17 00:00:00 2001 From: Sayed Adel Date: Tue, 31 Aug 2021 20:16:05 +0200 Subject: DOC: Improve Doxygen Javadoc style examples --- doc/source/dev/examples/doxy_func.h | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 doc/source/dev/examples/doxy_func.h (limited to 'doc/source/dev/examples/doxy_func.h') 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); -- cgit v1.2.1