فهرست منبع

doc(doxyge):fix doxygen path

Supper Thomas 4 ماه پیش
والد
کامیت
5b75e1c8bf
3فایلهای تغییر یافته به همراه15 افزوده شده و 4 حذف شده
  1. 12 1
      .github/workflows/doxygen.yml
  2. 2 2
      components/dfs/dfs_v2/src/dfs_posix.c
  3. 1 1
      components/drivers/include/drivers/dev_spi.h

+ 12 - 1
.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:

+ 2 - 2
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.

+ 1 - 1
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.
  */