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:
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

View 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.
*/