mirror of
https://github.com/RT-Thread/rt-thread.git
synced 2025-10-19 03:13:34 +08:00
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 <unicorn_wang@outlook.com>
This commit is contained in:
9
documentation/0.doxygen/doxygen.h
Normal file
9
documentation/0.doxygen/doxygen.h
Normal file
@@ -0,0 +1,9 @@
|
||||
/*
|
||||
* This file is only used for doxygen document generation.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup group_doxygen_example Doxygen Example
|
||||
*
|
||||
* @brief Introduce how to write doxygen documentation.
|
||||
*/
|
Reference in New Issue
Block a user