RT-Thread/rt-thread
1
0
Fork 0
mirror of https://github.com/RT-Thread/rt-thread.git synced 2025-10-19 20:43:43 +08:00
Code Issues Packages Projects Releases Wiki Activity

doxygen: add documentation for doxygen

Browse Source 
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 <unicorn_wang@outlook.com>
This commit is contained in:
Chen Wang
2025-02-06 14:31:06 +08:00
committed by Rbb666
parent 74f43edd6c
commit 761bb89f27
14 changed files with 569 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
documentation/0.doxygen/example/include/function.h Normal file
View File

@@ -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_ */