Skip to content

Commit 5b75e1c

Browse files
supperthomasmysterywolf
authored andcommitted
doc(doxyge):fix doxygen path
1 parent f5b6ae4 commit 5b75e1c

File tree

3 files changed

+15
-4
lines changed

3 files changed

+15
-4
lines changed

Diff for: .github/workflows/doxygen.yml

+12-1
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,24 @@
11
name: doc_doxygen
22
on:
3+
pull_request:
4+
branches:
5+
- master
6+
paths:
7+
- 'documentation/doxygen/**'
8+
- 'src/**'
9+
- 'include/**'
10+
- 'components/drivers/include/drivers/**'
11+
- 'components/dfs/dfs_v2/include/**'
12+
- 'components/dfs/dfs_v2/src/**'
13+
- 'components/finsh/**'
314
# Runs at 16:00 UTC (BeiJing 00:00) on the 30st of every month
415
schedule:
516
- cron: '0 16 30 * *'
617
workflow_dispatch:
718

819
jobs:
920
build:
10-
runs-on: ubuntu-latest
21+
runs-on: ubuntu-22.04
1122
name: doxygen_doc generate
1223
if: github.repository_owner == 'RT-Thread'
1324
steps:

Diff for: components/dfs/dfs_v2/src/dfs_posix.c

+2-2
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,9 @@ RTM_EXPORT(open);
9696
* @brief Opens a file relative to a directory file descriptor.
9797
*
9898
* @param dirfd The file descriptor of the directory to base the relative path on.
99-
* @param pathname The path to the file to be opened, relative to the directory specified by `dirfd`.
99+
* @param path The path to the file to be opened, relative to the directory specified by `dirfd`.
100100
* Can be an absolute path (in which case `dirfd` is ignored).
101-
* @param flags File access and status flags (e.g., `O_RDONLY`, `O_WRONLY`, `O_CREAT`).
101+
* @param flag File access and status flags (e.g., `O_RDONLY`, `O_WRONLY`, `O_CREAT`).
102102
*
103103
* @return On success, returns a new file descriptor for the opened file.
104104
* On failure, returns `-1` and sets `errno` to indicate the error.

Diff for: components/drivers/include/drivers/dev_spi.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -618,7 +618,7 @@ rt_err_t rt_qspi_send_then_recv(struct rt_qspi_device *device, const void *send_
618618
*
619619
* @param device the QSPI device attached to QSPI bus.
620620
* @param send_buf the buffer to be transmitted to QSPI device.
621-
* @param send_length the number of data to be transmitted.
621+
* @param length the number of data to be transmitted.
622622
*
623623
* @return the status of transmit.
624624
*/

0 commit comments

Comments
 (0)