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 /.github/workflows | |
| 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 '.github/workflows')
| -rw-r--r-- | .github/workflows/doxygen.yml | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index 697ce412d9..9f922861bf 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -4,25 +4,27 @@ on: branches: - master paths: - - 'documentation/doxygen/**' + - 'documentation/**' - 'src/**' - 'include/**' + - 'components/finsh/**' - 'components/drivers/include/drivers/**' - - 'components/dfs/dfs_v2/include/**' + - 'components/drivers/clk/**' - 'components/dfs/dfs_v2/src/**' - - 'components/finsh/**' + - 'components/dfs/dfs_v2/include/**' - '.github/workflows/doxygen.yml' # Runs at 16:00 UTC (BeiJing 00:00) on the 30st of every month push: branches: [master] paths: - - 'documentation/doxygen/**' + - 'documentation/**' - 'src/**' - 'include/**' + - 'components/finsh/**' - 'components/drivers/include/drivers/**' - - 'components/dfs/dfs_v2/include/**' + - 'components/drivers/clk/**' - 'components/dfs/dfs_v2/src/**' - - 'components/finsh/**' + - 'components/dfs/dfs_v2/include/**' - '.github/workflows/doxygen.yml' schedule: - cron: '0 16 30 * *' |