From f5a8f11be9da6347e84154d6fb09482c232207ff Mon Sep 17 00:00:00 2001 From: Supper Thomas <78900636@qq.com> Date: Mon, 9 Dec 2024 12:18:31 +0000 Subject: [PATCH] doc(doxyge):fix doxygen path --- .github/workflows/doxygen.yml | 13 ++++++++++++- components/dfs/dfs_v2/src/dfs_posix.c | 4 ++-- components/drivers/include/drivers/dev_spi.h | 2 +- 3 files changed, 15 insertions(+), 4 deletions(-) diff --git a/.github/workflows/doxygen.yml b/.github/workflows/doxygen.yml index a4580be1be1..b06f4290949 100644 --- a/.github/workflows/doxygen.yml +++ b/.github/workflows/doxygen.yml @@ -1,5 +1,16 @@ name: doc_doxygen on: + pull_request: + branches: + - master + paths: + - 'documentation/doxygen/**' + - 'src/**' + - 'include/**' + - 'components/drivers/include/drivers/**' + - 'components/dfs/dfs_v2/include/**' + - 'components/dfs/dfs_v2/src/**' + - 'components/finsh/**' # Runs at 16:00 UTC (BeiJing 00:00) on the 30st of every month schedule: - cron: '0 16 30 * *' @@ -7,7 +18,7 @@ on: jobs: build: - runs-on: ubuntu-latest + runs-on: ubuntu-22.04 name: doxygen_doc generate if: github.repository_owner == 'RT-Thread' steps: diff --git a/components/dfs/dfs_v2/src/dfs_posix.c b/components/dfs/dfs_v2/src/dfs_posix.c index 47da7548f8d..38e17c350a9 100644 --- a/components/dfs/dfs_v2/src/dfs_posix.c +++ b/components/dfs/dfs_v2/src/dfs_posix.c @@ -96,9 +96,9 @@ RTM_EXPORT(open); * @brief Opens a file relative to a directory file descriptor. * * @param dirfd The file descriptor of the directory to base the relative path on. - * @param pathname The path to the file to be opened, relative to the directory specified by `dirfd`. + * @param path The path to the file to be opened, relative to the directory specified by `dirfd`. * Can be an absolute path (in which case `dirfd` is ignored). - * @param flags File access and status flags (e.g., `O_RDONLY`, `O_WRONLY`, `O_CREAT`). + * @param flag File access and status flags (e.g., `O_RDONLY`, `O_WRONLY`, `O_CREAT`). * * @return On success, returns a new file descriptor for the opened file. * On failure, returns `-1` and sets `errno` to indicate the error. diff --git a/components/drivers/include/drivers/dev_spi.h b/components/drivers/include/drivers/dev_spi.h index ad23453d5bf..0aa08c49e82 100644 --- a/components/drivers/include/drivers/dev_spi.h +++ b/components/drivers/include/drivers/dev_spi.h @@ -618,7 +618,7 @@ rt_err_t rt_qspi_send_then_recv(struct rt_qspi_device *device, const void *send_ * * @param device the QSPI device attached to QSPI bus. * @param send_buf the buffer to be transmitted to QSPI device. - * @param send_length the number of data to be transmitted. + * @param length the number of data to be transmitted. * * @return the status of transmit. */