Skip to content

Commit

Permalink
doc(doxyge):fix doxygen path
Browse files Browse the repository at this point in the history
  • Loading branch information
supperthomas authored and mysterywolf committed Dec 9, 2024
1 parent f5b6ae4 commit 5b75e1c
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 4 deletions.
13 changes: 12 additions & 1 deletion .github/workflows/doxygen.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,24 @@
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 * *'
workflow_dispatch:

jobs:
build:
runs-on: ubuntu-latest
runs-on: ubuntu-22.04
name: doxygen_doc generate
if: github.repository_owner == 'RT-Thread'
steps:
Expand Down
4 changes: 2 additions & 2 deletions components/dfs/dfs_v2/src/dfs_posix.c
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion components/drivers/include/drivers/dev_spi.h
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*/
Expand Down

0 comments on commit 5b75e1c

Please sign in to comment.