From 761bb89f27d7e2569fce48b06faf5825fa645f17 Mon Sep 17 00:00:00 2001 From: Chen Wang Date: Thu, 6 Feb 2025 14:31:06 +0800 Subject: doxygen: add documentation for doxygen Documentation is provided to clarify how to write doxygen documentation for RT-Thread. This document is also integrated as part of RT-Thread doxygen documentation. An example is also provided. The original README.md is removed and integrated into this document. Updated github actions for doxygen too. Signed-off-by: Chen Wang --- documentation/0.doxygen/example/include/function.h | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 documentation/0.doxygen/example/include/function.h (limited to 'documentation/0.doxygen/example/include/function.h') diff --git a/documentation/0.doxygen/example/include/function.h b/documentation/0.doxygen/example/include/function.h new file mode 100644 index 0000000000..5b414240df --- /dev/null +++ b/documentation/0.doxygen/example/include/function.h @@ -0,0 +1,7 @@ +#ifndef _DOXYGEN_EXAMPLE_FUNCTION_H_ +#define _DOXYGEN_EXAMPLE_FUNCTION_H_ + +void doxygen_example_func_foo(int a, int b); +int doxygen_example_func_bar(int a, int* b); + +#endif /* _DOXYGEN_EXAMPLE_FUNCTION_H_ */ -- cgit v1.3.1