Skip to content

Commit 528c64e

Browse files
committed
更新 xy_run_* 注释
1 parent ffebe16 commit 528c64e

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

lib/xy.h

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
* | BingChunMoLi <[email protected]>
1010
* |
1111
* Created On : <2023-08-28>
12-
* Last Modified : <2025-10-28>
12+
* Last Modified : <2025-12-31>
1313
*
1414
*
1515
* xy: 襄阳、咸阳
@@ -943,10 +943,10 @@ xy_quiet_cmd (const char *cmd)
943943

944944

945945
/**
946-
* @brief 执行 `cmd`,返回某行输出结果,并对已经遍历过的行执行 `func`
946+
* @brief 执行 `cmd`,返回其输出到 stdout 的内容中的第 `n` 行,并对已经遍历过的行执行 `func`
947947
*
948948
* @param cmd 要执行的命令
949-
* @param n 指定命令执行输出的结果行中的某一行,0 表示最后一行,n (n>0) 表示第n行
949+
* @param n 指定命令执行输出到 stdout 内容中的某一行,0 表示最后一行,n (n>0) 表示第n行
950950
* @param func 对遍历时经过的行的内容,进行函数调用,如果返回 true,则提前停止遍历
951951
*
952952
* @return
@@ -995,6 +995,11 @@ xy_run_iter_lines (const char *cmd, unsigned long n, bool (*func) (const char
995995
return ret;
996996
}
997997

998+
/**
999+
* @brief 执行命令 `cmd`,返回第 `n` 行输出到 stdout 的内容
1000+
*
1001+
* @return 返回第 `n` 行输出到 stdout 的内容
1002+
*/
9981003
static char *
9991004
xy_run (const char *cmd, unsigned long n)
10001005
{
@@ -1003,7 +1008,9 @@ xy_run (const char *cmd, unsigned long n)
10031008

10041009

10051010
/**
1006-
* @brief 执行命令,仅返回命令的执行状态
1011+
* @brief 执行命令 `cmd`,仅返回其 Exit Code,stdout 与 stderr 均不输出到终端
1012+
*
1013+
* @return 返回 `cmd` 的 Exit Code
10071014
*/
10081015
int
10091016
xy_run_get_status (char *cmd)
@@ -1016,7 +1023,7 @@ xy_run_get_status (char *cmd)
10161023

10171024

10181025
/**
1019-
* @brief 捕获命令的输出
1026+
* @brief 获得执行命令 `cmd` 输出到 stdout 的内容,而 stderr 依然输出到终端
10201027
*
10211028
* @param[in] cmd 要执行的命令
10221029
* @param[out] output 捕获的标准输出,

0 commit comments

Comments
 (0)