Skip to content

Commit f5d0513

Browse files
committed
update docs
1 parent f1e7754 commit f5d0513

File tree

6 files changed

+48
-0
lines changed

6 files changed

+48
-0
lines changed

docs/api/scripts/option-instance.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,10 @@ option:set("defines", "SDL_MAIN_HANDLED")
3636
option:set("configvar", option:name(), option:value(), {quote = false})
3737
```
3838

39+
::: tip NOTE
40+
Any script scope configuration using `option:set("xxx", ...)` is completely consistent with the corresponding `set_xxx` interface in the description scope. For specific parameter descriptions, you can directly refer to the corresponding `set_xxx` interface documentation in the description scope.
41+
:::
42+
3943
## option:add
4044

4145
- Add to the values of the option by name
@@ -47,6 +51,10 @@ option:add("links", "sdl2")
4751
option:add("defines", "SDL_MAIN_HANDLED")
4852
```
4953

54+
::: tip NOTE
55+
Any script scope configuration using `option:add("xxx", ...)` is completely consistent with the corresponding `add_xxx` interface in the description scope. For specific parameter descriptions, you can directly refer to the corresponding `add_xxx` interface documentation in the description scope.
56+
:::
57+
5058
::: tip NOTE
5159
The document here is still in progress, please be patient, you can also speed up the update of the document by sponsoring or submiting pr
5260
:::

docs/api/scripts/package-instance.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@ package:set("links", "sdl2")
3434
package:set("defines", "SDL_MAIN_HANDLED")
3535
```
3636

37+
::: tip NOTE
38+
Any script scope configuration using `package:set("xxx", ...)` is completely consistent with the corresponding `set_xxx` interface in the description scope. For specific parameter descriptions, you can directly refer to the corresponding `set_xxx` interface documentation in the description scope.
39+
:::
40+
3741
## package:add
3842

3943
- Add to the values of the package by name
@@ -47,6 +51,10 @@ package:add("links", "sdl2")
4751
package:add("defines", "SDL_MAIN_HANDLED")
4852
```
4953

54+
::: tip NOTE
55+
Any script scope configuration using `package:add("xxx", ...)` is completely consistent with the corresponding `add_xxx` interface in the description scope. For specific parameter descriptions, you can directly refer to the corresponding `add_xxx` interface documentation in the description scope.
56+
:::
57+
5058
## package:license
5159

5260
- Get the license of the package

docs/api/scripts/target-instance.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,10 @@ target:set("links", "sdl2")
3030
target:set("defines", "SDL_MAIN_HANDLED")
3131
```
3232

33+
::: tip NOTE
34+
Any script scope configuration using `target:set("xxx", ...)` is completely consistent with the corresponding `set_xxx` interface in the description scope. For specific parameter descriptions, you can directly refer to the corresponding `set_xxx` interface documentation in the description scope.
35+
:::
36+
3337
## target:add
3438

3539
- Add to the values of the target by name
@@ -41,6 +45,10 @@ target:add("links", "sdl2")
4145
target:add("defines", "SDL_MAIN_HANDLED")
4246
```
4347

48+
::: tip NOTE
49+
Any script scope configuration using `target:add("xxx", ...)` is completely consistent with the corresponding `add_xxx` interface in the description scope. For specific parameter descriptions, you can directly refer to the corresponding `add_xxx` interface documentation in the description scope.
50+
:::
51+
4452
## target:kind
4553

4654
- Get the target program type

docs/zh/api/scripts/option-instance.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,10 @@ option:set("defines", "SDL_MAIN_HANDLED")
3939
option:set("configvar", option:name(), option:value(), {quote = false})
4040
```
4141

42+
::: tip 注意
43+
任何脚本域下对 `option:set("xxx", ...)` 的配置,都是完全跟描述域的 `set_xxx` 接口保持一致的,具体参数说明,可以直接参考描述域下对应的 `set_xxx` 接口说明。
44+
:::
45+
4246
## option:add
4347

4448
- 按名称添加到选项的值
@@ -50,6 +54,10 @@ option:add("links", "sdl2")
5054
option:add("defines", "SDL_MAIN_HANDLED")
5155
```
5256

57+
::: tip 注意
58+
任何脚本域下对 `option:add("xxx", ...)` 的配置,都是完全跟描述域的 `add_xxx` 接口保持一致的,具体参数说明,可以直接参考描述域下对应的 `add_xxx` 接口说明。
59+
:::
60+
5361
::: tip 注意
5462
此处文档还在进行中,请耐心等待,你也可以通过赞助或者提 pr 来加速文档的更新
5563
:::

docs/zh/api/scripts/package-instance.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,10 @@ package:set("links", "sdl2")
3636
package:set("defines", "SDL_MAIN_HANDLED")
3737
```
3838

39+
::: tip 注意
40+
任何脚本域下对 `package:set("xxx", ...)` 的配置,都是完全跟描述域的 `set_xxx` 接口保持一致的,具体参数说明,可以直接参考描述域下对应的 `set_xxx` 接口说明。
41+
:::
42+
3943
## package:add
4044

4145
- 按名称添加到包的值
@@ -49,6 +53,10 @@ package:add("links", "sdl2")
4953
package:add("defines", "SDL_MAIN_HANDLED")
5054
```
5155

56+
::: tip 注意
57+
任何脚本域下对 `package:add("xxx", ...)` 的配置,都是完全跟描述域的 `add_xxx` 接口保持一致的,具体参数说明,可以直接参考描述域下对应的 `add_xxx` 接口说明。
58+
:::
59+
5260
## package:license
5361

5462
- 获取包的许可证(同`package:get("license")`

docs/zh/api/scripts/target-instance.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ target:set("links", "sdl2")
3232
target:set("defines", "SDL_MAIN_HANDLED")
3333
```
3434

35+
::: tip 注意
36+
任何脚本域下对 `target:set("xxx", ...)` 的配置,都是完全跟描述域的 `set_xxx` 接口保持一致的,具体参数说明,可以直接参考描述域下对应的 `set_xxx` 接口说明。
37+
:::
38+
3539
## target:add
3640

3741
- 按名称添加到目标的值
@@ -43,6 +47,10 @@ target:add("links", "sdl2")
4347
target:add("defines", "SDL_MAIN_HANDLED")
4448
```
4549

50+
::: tip 注意
51+
任何脚本域下对 `target:add("xxx", ...)` 的配置,都是完全跟描述域的 `add_xxx` 接口保持一致的,具体参数说明,可以直接参考描述域下对应的 `add_xxx` 接口说明。
52+
:::
53+
4654
## target:kind
4755

4856
- 获取目标程序类型

0 commit comments

Comments
 (0)