diff options
| author | Chen Wang <[email protected]> | 2025-02-06 14:31:06 +0800 |
|---|---|---|
| committer | Rbb666 <[email protected]> | 2025-02-11 17:09:44 +0800 |
| commit | 761bb89f27d7e2569fce48b06faf5825fa645f17 (patch) | |
| tree | 7948cc254f3b4ee3cacef9d273b84ac15bc04c4b /documentation/0.doxygen/example/include/function.h | |
| parent | 74f43edd6c4f12f3902d1f64774b925361d74e5b (diff) | |
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 <[email protected]>
Diffstat (limited to 'documentation/0.doxygen/example/include/function.h')
| -rw-r--r-- | documentation/0.doxygen/example/include/function.h | 7 |
1 files changed, 7 insertions, 0 deletions
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_ */ |