Added action to check for missing documentation

- Added auto-generated documentation files for APIs without docs
- Renamed editAndContinue.md to editandcontinue.md to match convention
This commit is contained in:
Sam Surtees 2021-10-04 19:20:00 +10:00
parent 50051b9589
commit 0fb9327993
57 changed files with 1373 additions and 10 deletions

View File

@ -16,6 +16,8 @@ jobs:
run: make -f Bootstrap.mak linux PLATFORM=${{ matrix.platform }} CONFIG=${{ matrix.config }}
- name: Test
run: bin/${{ matrix.config }}/premake5 test --test-all
- name: Docs check
run: bin/${{ matrix.config }}/premake5 docs-check
- name: Upload Artifacts
if: matrix.config == 'release'
uses: actions/upload-artifact@v2
@ -35,6 +37,8 @@ jobs:
run: make -f Bootstrap.mak macosx PLATFORM=${{ matrix.platform }} CONFIG=${{ matrix.config }}
- name: Test
run: bin/${{ matrix.config }}/premake5 test --test-all
- name: Docs check
run: bin/${{ matrix.config }}/premake5 docs-check
- name: Upload Artifacts
if: matrix.config == 'release'
uses: actions/upload-artifact@v2
@ -58,6 +62,9 @@ jobs:
- name: Test
run: bin\${{ matrix.config }}\premake5 test --test-all
shell: cmd
- name: Docs check
run: bin\${{ matrix.config }}\premake5 docs-check
shell: cmd
- name: Upload Artifacts
if: matrix.config == 'release'
uses: actions/upload-artifact@v2

View File

@ -40,6 +40,15 @@
}
newaction {
trigger = "docs-check",
description = "Validates documentation files for Premake APIs",
execute = function ()
include (path.join(corePath, "scripts/docscheck.lua"))
end
}
newaction {
trigger = "test",
description = "Run the automated test suite",

14
scripts/docscheck.lua Normal file
View File

@ -0,0 +1,14 @@
---
-- Validate documentation for Premkake APIs.
---
local count = 0
for k,v in pairs(premake.field._loweredList) do
local docfilepath = "../website/docs/" .. k .. ".md"
local exists = os.isfile(docfilepath)
if not exists then
print("Missing documentation file for: ", k)
count = count + 1
end
end
os.exit(count)

View File

@ -19,6 +19,6 @@ Many of the old [`flags`](flags.md) have become full-fledged functions. This sho
| `FloatFast`, `FloatStrict` | [`floatingpoint`](floatingpoint.md) |
| `Managed`, `Unsafe` | [`clr`](clr.md) |
| `NativeWChar` | [`nativewchar`](nativewchar.md) |
| `NoEditAndContinue` | [`editandcontinue`](editAndContinue.md) |
| `NoEditAndContinue` | [`editandcontinue`](editandcontinue.md) |
| `NoRTTI` | [`rtti`](rtti.md) |
| `OptimizeSize`, `OptimizeSpeed` | [`optimize`](optimize.md) |

View File

@ -69,7 +69,7 @@
| [display](display.md) | |
| [docdir](docdir.md) | |
| [docname](docname.md) | |
| [editandcontinue](editAndContinue.md) | |
| [editandcontinue](editandcontinue.md) | |
| [editorintegration](editorintegration.md) | Enable or disable IDE integration |
| [enablewarnings](enablewarnings.md) | |
| [endian](endian.md) | |

View File

@ -63,7 +63,7 @@ title: What's New in 5.0
* [dependson](dependson.md) (new)
* [disablewarnings](disablewarnings.md) (new)
* [dotnetframework](dotnetframework.md) (new)
* [editandcontinue](editAndContinue.md) (new, replaces flag `NoEditAndContinue`)
* [editandcontinue](editandcontinue.md) (new, replaces flag `NoEditAndContinue`)
* [editorintegration](editorintegration.md) (new)
* [enablewarnings](enablewarnings.md) (new)
* [endian](endian.md) (new)
@ -151,6 +151,6 @@ title: What's New in 5.0
* FloatFast, FloatStrict: use [floatingpoint](floatingpoint.md) instead
* Managed, Unsafe: use [clr](clr.md) instead
* NativeWChar: use [nativewchar](nativewchar.md) instead
* NoEditAndContinue: use [editandcontinue](editAndContinue.md) instead
* NoEditAndContinue: use [editandcontinue](editandcontinue.md) instead
* NoRTTI: use [rtti](rtti.md) instead.
* OptimizeSize, OptimizeSpeed: use [optimize](optimize.md) instead

View File

@ -0,0 +1,24 @@
androidapilevel - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
androidapilevel (value)
```
### Parameters ###
`value` - needs documentation.
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 14 or later.
### Examples ###
```lua
androidapilevel (value)
```

View File

@ -0,0 +1,24 @@
androidapplibname - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
androidapplibname (value)
```
### Parameters ###
`value` - needs documentation.
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 14 or later.
### Examples ###
```lua
androidapplibname (value)
```

View File

@ -0,0 +1,24 @@
assemblydebug - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
assemblydebug (value)
```
### Parameters ###
`value` - needs documentation.
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 16 or later.
### Examples ###
```lua
assemblydebug (value)
```

View File

@ -0,0 +1,29 @@
boundscheck - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
boundscheck (value)
```
### Parameters ###
`value` is one of:
* `Default`: needs documentation
* `Off`: needs documentation
* `On`: needs documentation
* `SafeOnly`: needs documentation
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 14 or later.
### Examples ###
```lua
boundscheck (value)
```

View File

@ -0,0 +1,30 @@
checkaction - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
checkaction (value)
```
### Parameters ###
`value` is one of:
* `Default`: needs documentation
* `D`: needs documentation
* `C`: needs documentation
* `Halt`: needs documentation
* `Context`: needs documentation
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 16 or later.
### Examples ###
```lua
checkaction (value)
```

View File

@ -0,0 +1,29 @@
compilationmodel - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
compilationmodel (value)
```
### Parameters ###
`value` is one of:
* `Default`: needs documentation
* `File`: needs documentation
* `Package`: needs documentation
* `Project`: needs documentation
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 14 or later.
### Examples ###
```lua
compilationmodel (value)
```

View File

@ -0,0 +1,24 @@
computetargets - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
computetargets (value)
```
### Parameters ###
`value` - needs documentation.
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 16 or later.
### Examples ###
```lua
computetargets (value)
```

View File

@ -0,0 +1,24 @@
conformancemode - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
conformancemode (value)
```
### Parameters ###
`value` - needs documentation.
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 beta 1 or later.
### Examples ###
```lua
conformancemode (value)
```

View File

@ -12,7 +12,7 @@ debugformat "format"
|-------------|---------------------------------------------------------------------------------------------|
| c7 | Specifies that MSVC should store debuginfo in the objects rather than a separate .pdb file. |
**Note for Visual Studio Users:** Use [editAndContinue](editAndContinue.md) to control the `/Zi` and `/ZI` switches; see [this discussion](https://github.com/premake/premake-core/issues/1425) for more information.
**Note for Visual Studio Users:** Use [editandcontinue](editandcontinue.md) to control the `/Zi` and `/ZI` switches; see [this discussion](https://github.com/premake/premake-core/issues/1425) for more information.
### Applies To ###
@ -24,5 +24,5 @@ Premake 5.0 or later.
### See Also ###
- [editAndContinue](editAndContinue.md)
- [editandcontinue](editandcontinue.md)

View File

@ -0,0 +1,29 @@
debuggerflavor - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
debuggerflavor (value)
```
### Parameters ###
`value` is one of:
* `Local`: needs documentation
* `Remote`: needs documentation
* `WebBrowser`: needs documentation
* `WebService`: needs documentation
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 14 or later.
### Examples ###
```lua
debuggerflavor (value)
```

View File

@ -0,0 +1,24 @@
dependenciesfile - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
dependenciesfile (value)
```
### Parameters ###
`value` - needs documentation.
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 14 or later.
### Examples ###
```lua
dependenciesfile (value)
```

View File

@ -0,0 +1,29 @@
deprecatedfeatures - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
deprecatedfeatures (value)
```
### Parameters ###
`value` is one of:
* `Default`: needs documentation
* `Allow`: needs documentation
* `Warn`: needs documentation
* `Error`: needs documentation
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 14 or later.
### Examples ###
```lua
deprecatedfeatures (value)
```

View File

@ -1,7 +1,7 @@
Turns the edit-and-continue features of a toolset or platform on and off.
```lua
editAndContinue "value"
editandcontinue "value"
```
If no value is set for a configuration, the toolset's default setting (usually "On") will be used.
@ -22,7 +22,7 @@ Premake 5.0 or later.
```lua
-- Turn off edit and continue
editAndContinue "Off"
editandcontinue "Off"
```
### See Also ###

24
website/docs/embed.md Normal file
View File

@ -0,0 +1,24 @@
embed - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
embed (value)
```
### Parameters ###
`value` - needs documentation.
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 beta 1 or later.
### Examples ###
```lua
embed (value)
```

View File

@ -0,0 +1,24 @@
embedandsign - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
embedandsign (value)
```
### Parameters ###
`value` - needs documentation.
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 beta 1 or later.
### Examples ###
```lua
embedandsign (value)
```

View File

@ -0,0 +1,24 @@
enabledefaultcompileitems - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
enabledefaultcompileitems (value)
```
### Parameters ###
`value` - needs documentation.
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 16 or later.
### Examples ###
```lua
enabledefaultcompileitems (value)
```

View File

@ -0,0 +1,24 @@
fastuptodate - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
fastuptodate (value)
```
### Parameters ###
`value` - needs documentation.
## Applies To ###
The `project` scope.
### Availability ###
Premake 5.0.0 beta 1 or later.
### Examples ###
```lua
fastuptodate (value)
```

28
website/docs/floatabi.md Normal file
View File

@ -0,0 +1,28 @@
floatabi - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
floatabi (value)
```
### Parameters ###
`value` is one of:
* `soft`: needs documentation
* `softfp`: needs documentation
* `hard`: needs documentation
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 14 or later.
### Examples ###
```lua
floatabi (value)
```

View File

@ -0,0 +1,24 @@
frameworkdirs - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
frameworkdirs (value)
```
### Parameters ###
`value` - needs documentation.
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 11 or later.
### Examples ###
```lua
frameworkdirs (value)
```

View File

@ -0,0 +1,24 @@
importdirs - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
importdirs (value)
```
### Parameters ###
`value` - needs documentation.
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 14 or later.
### Examples ###
```lua
importdirs (value)
```

View File

@ -0,0 +1,27 @@
inlinesvisibility - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
inlinesvisibility (value)
```
### Parameters ###
`value` is one of:
* `Default`: needs documentation
* `Hidden`: needs documentation
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 14 or later.
### Examples ###
```lua
inlinesvisibility (value)
```

28
website/docs/iosfamily.md Normal file
View File

@ -0,0 +1,28 @@
iosfamily - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
iosfamily (value)
```
### Parameters ###
`value` is one of:
* `iPhone/iPod touch`: needs documentation
* `iPad`: needs documentation
* `Universal`: needs documentation
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 14 or later.
### Examples ###
```lua
iosfamily (value)
```

View File

@ -0,0 +1,36 @@
isaextensions - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
isaextensions (value)
```
### Parameters ###
`value` is one of:
* `MOVBE`: needs documentation
* `POPCNT`: needs documentation
* `PCLMUL`: needs documentation
* `LZCNT`: needs documentation
* `BMI`: needs documentation
* `BMI2`: needs documentation
* `F16C`: needs documentation
* `AES`: needs documentation
* `FMA`: needs documentation
* `FMA4`: needs documentation
* `RDRND`: needs documentation
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 14 or later.
### Examples ###
```lua
isaextensions (value)
```

24
website/docs/jsonfile.md Normal file
View File

@ -0,0 +1,24 @@
jsonfile - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
jsonfile (value)
```
### Parameters ###
`value` - needs documentation.
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 14 or later.
### Examples ###
```lua
jsonfile (value)
```

View File

@ -0,0 +1,28 @@
omitframepointer - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
omitframepointer (value)
```
### Parameters ###
`value` is one of:
* `Default`: needs documentation
* `On`: needs documentation
* `Off`: needs documentation
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 14 or later.
### Examples ###
```lua
omitframepointer (value)
```

33
website/docs/preview.md Normal file
View File

@ -0,0 +1,33 @@
preview - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
preview (value)
```
### Parameters ###
`value` is one of:
* `dip25`: needs documentation
* `dip1000`: needs documentation
* `dip1008`: needs documentation
* `fieldwise`: needs documentation
* `markdown`: needs documentation
* `fixAliasThis`: needs documentation
* `intpromote`: needs documentation
* `dtorfields`: needs documentation
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 16 or later.
### Examples ###
```lua
preview (value)
```

27
website/docs/revert.md Normal file
View File

@ -0,0 +1,27 @@
revert - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
revert (value)
```
### Parameters ###
`value` is one of:
* `dip25`: needs documentation
* `import`: needs documentation
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 16 or later.
### Examples ###
```lua
revert (value)
```

View File

@ -0,0 +1,28 @@
shaderassembler - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
shaderassembler (value)
```
### Parameters ###
`value` is one of:
* `NoListing`: needs documentation
* `AssemblyCode`: needs documentation
* `AssemblyCodeAndHex`: needs documentation
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 14 or later.
### Examples ###
```lua
shaderassembler (value)
```

View File

@ -0,0 +1,24 @@
shaderassembleroutput - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
shaderassembleroutput (value)
```
### Parameters ###
`value` - needs documentation.
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 14 or later.
### Examples ###
```lua
shaderassembleroutput (value)
```

View File

@ -0,0 +1,24 @@
shaderdefines - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
shaderdefines (value)
```
### Parameters ###
`value` - needs documentation.
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 14 or later.
### Examples ###
```lua
shaderdefines (value)
```

View File

@ -0,0 +1,24 @@
shaderentry - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
shaderentry (value)
```
### Parameters ###
`value` - needs documentation.
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 14 or later.
### Examples ###
```lua
shaderentry (value)
```

View File

@ -0,0 +1,24 @@
shaderheaderfileoutput - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
shaderheaderfileoutput (value)
```
### Parameters ###
`value` - needs documentation.
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 14 or later.
### Examples ###
```lua
shaderheaderfileoutput (value)
```

View File

@ -0,0 +1,24 @@
shaderincludedirs - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
shaderincludedirs (value)
```
### Parameters ###
`value` - needs documentation.
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 16 or later.
### Examples ###
```lua
shaderincludedirs (value)
```

View File

@ -0,0 +1,41 @@
shadermodel - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
shadermodel (value)
```
### Parameters ###
`value` is one of:
* `2.0`: needs documentation
* `3.0`: needs documentation
* `4.0_level_9_1`: needs documentation
* `4.0_level_9_3`: needs documentation
* `4.0`: needs documentation
* `4.1`: needs documentation
* `5.0`: needs documentation
* `5.1`: needs documentation
* `rootsig_1.0`: needs documentation
* `rootsig_1.1`: needs documentation
* `6.0`: needs documentation
* `6.1`: needs documentation
* `6.2`: needs documentation
* `6.3`: needs documentation
* `6.4`: needs documentation
* `6.5`: needs documentation
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 14 or later.
### Examples ###
```lua
shadermodel (value)
```

View File

@ -0,0 +1,24 @@
shaderobjectfileoutput - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
shaderobjectfileoutput (value)
```
### Parameters ###
`value` - needs documentation.
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 14 or later.
### Examples ###
```lua
shaderobjectfileoutput (value)
```

View File

@ -0,0 +1,24 @@
shaderoptions - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
shaderoptions (value)
```
### Parameters ###
`value` - needs documentation.
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 14 or later.
### Examples ###
```lua
shaderoptions (value)
```

View File

@ -0,0 +1,36 @@
shadertype - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
shadertype (value)
```
### Parameters ###
`value` is one of:
* `Effect`: needs documentation
* `Vertex`: needs documentation
* `Pixel`: needs documentation
* `Geometry`: needs documentation
* `Hull`: needs documentation
* `Domain`: needs documentation
* `Compute`: needs documentation
* `Mesh`: needs documentation
* `Amplification`: needs documentation
* `Texture`: needs documentation
* `RootSignature`: needs documentation
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 14 or later.
### Examples ###
```lua
shadertype (value)
```

View File

@ -0,0 +1,24 @@
shadervariablename - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
shadervariablename (value)
```
### Parameters ###
`value` - needs documentation.
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 14 or later.
### Examples ###
```lua
shadervariablename (value)
```

30
website/docs/stl.md Normal file
View File

@ -0,0 +1,30 @@
stl - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
stl (value)
```
### Parameters ###
`value` is one of:
* `none`: needs documentation
* `gabi++`: needs documentation
* `stlport`: needs documentation
* `gnu`: needs documentation
* `libc++`: needs documentation
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 14 or later.
### Examples ###
```lua
stl (value)
```

View File

@ -0,0 +1,24 @@
stringimportdirs - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
stringimportdirs (value)
```
### Parameters ###
`value` - needs documentation.
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 14 or later.
### Examples ###
```lua
stringimportdirs (value)
```

View File

@ -0,0 +1,30 @@
structmemberalign - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
structmemberalign (value)
```
### Parameters ###
`value` is one of:
* `1`: needs documentation
* `2`: needs documentation
* `4`: needs documentation
* `8`: needs documentation
* `16`: needs documentation
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 14 or later.
### Examples ###
```lua
structmemberalign (value)
```

View File

@ -0,0 +1,28 @@
swiftversion - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
swiftversion (value)
```
### Parameters ###
`value` is one of:
* `4.0`: needs documentation
* `4.2`: needs documentation
* `5.0`: needs documentation
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 beta 1 or later.
### Examples ###
```lua
swiftversion (value)
```

24
website/docs/tailcalls.md Normal file
View File

@ -0,0 +1,24 @@
tailcalls - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
tailcalls (value)
```
### Parameters ###
`value` - needs documentation.
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 14 or later.
### Examples ###
```lua
tailcalls (value)
```

28
website/docs/thumbmode.md Normal file
View File

@ -0,0 +1,28 @@
thumbmode - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
thumbmode (value)
```
### Parameters ###
`value` is one of:
* `thumb`: needs documentation
* `arm`: needs documentation
* `disabled`: needs documentation
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 14 or later.
### Examples ###
```lua
thumbmode (value)
```

View File

@ -0,0 +1,33 @@
toolchainversion - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
toolchainversion (value)
```
### Parameters ###
`value` is one of:
* `4.6`: needs documentation
* `4.8`: needs documentation
* `4.9`: needs documentation
* `3.4`: needs documentation
* `3.5`: needs documentation
* `3.6`: needs documentation
* `3.8`: needs documentation
* `5.0`: needs documentation
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 14 or later.
### Examples ###
```lua
toolchainversion (value)
```

View File

@ -0,0 +1,30 @@
transition - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
transition (value)
```
### Parameters ###
`value` is one of:
* `field`: needs documentation
* `checkimports`: needs documentation
* `complex`: needs documentation
* `tls`: needs documentation
* `vmarkdown`: needs documentation
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 16 or later.
### Examples ###
```lua
transition (value)
```

View File

@ -0,0 +1,24 @@
unsignedchar - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
unsignedchar (value)
```
### Parameters ###
`value` - needs documentation.
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 14 or later.
### Examples ###
```lua
unsignedchar (value)
```

View File

@ -0,0 +1,24 @@
usefullpaths - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
usefullpaths (value)
```
### Parameters ###
`value` - needs documentation.
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 beta 1 or later.
### Examples ###
```lua
usefullpaths (value)
```

View File

@ -0,0 +1,24 @@
xcodecodesigningidentity - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
xcodecodesigningidentity (value)
```
### Parameters ###
`value` - needs documentation.
## Applies To ###
The `config` scope.
### Availability ###
Premake 5.0.0 alpha 14 or later.
### Examples ###
```lua
xcodecodesigningidentity (value)
```

View File

@ -0,0 +1,24 @@
xcodesystemcapabilities - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
```lua
xcodesystemcapabilities (value)
```
### Parameters ###
`value` - needs documentation.
## Applies To ###
The `project` scope.
### Availability ###
Premake 5.0.0 alpha 14 or later.
### Examples ###
```lua
xcodesystemcapabilities (value)
```

View File

@ -60,10 +60,14 @@ module.exports = {
type: 'category',
label: 'Project Settings',
items: [
'androidapilevel',
'androidapplibname',
'architecture',
'assemblydebug',
'atl',
'basedir',
'bindirs',
'boundscheck',
'buildaction',
'buildcommands',
'buildcustomizations',
@ -77,15 +81,19 @@ module.exports = {
'callingconvention',
'cdialect',
'characterset',
'checkaction',
'cleancommands',
'cleanextensions',
'clr',
'compilationmodel',
'compileas',
'compilebuildoutputs',
'computetargets',
'configfile',
'configmap',
'configuration',
'configurations',
'conformancemode',
'copylocal',
'cppdialect',
'csversion',
@ -100,6 +108,7 @@ module.exports = {
'debugextendedprotocol',
'debugformat',
'debugger',
'debuggerflavor',
'debuggertype',
'debuglevel',
'debugpathmap',
@ -111,8 +120,10 @@ module.exports = {
'debugtoolcommand',
'defaultplatform',
'defines',
'dependenciesfile',
'dependson',
'deploymentoptions',
'deprecatedfeatures',
'disablewarnings',
'display',
'docdir',
@ -120,8 +131,11 @@ module.exports = {
'dofileopt',
'dotnetframework',
'dpiawareness',
'editAndContinue',
'editandcontinue',
'editorintegration',
'embed',
'embedandsign',
'enabledefaultcompileitems',
'enablewarnings',
'endian',
'entrypoint',
@ -129,18 +143,21 @@ module.exports = {
'external',
'externalproject',
'externalrule',
'fastuptodate',
'fatalwarnings',
'fileextension',
'filename',
'files',
'filter',
'flags',
'floatabi',
'floatingpoint',
'floatingpointexceptions',
'forceincludes',
'forceusings',
'fpu',
'framework',
'frameworkdirs',
'functionlevellinking',
'gccprefix',
'group',
@ -155,9 +172,14 @@ module.exports = {
'implibname',
'implibprefix',
'implibsuffix',
'importdirs',
'includedirs',
'inlinesvisibility',
'inlining',
'intrinsics',
'iosfamily',
'isaextensions',
'jsonfile',
'justmycode',
'kind',
'language',
@ -177,6 +199,7 @@ module.exports = {
'nuget',
'nugetsource',
'objdir',
'omitframepointer',
'openmp',
'optimize',
'pchheader',
@ -190,6 +213,7 @@ module.exports = {
'preferredtoolarchitecture',
'prelinkcommands',
'prelinkmessage',
'preview',
'project',
'propertydefinition',
'rebuildcommands',
@ -198,16 +222,32 @@ module.exports = {
'resincludedirs',
'resoptions',
'resourcegenerator',
'revert',
'rtti',
'rule',
'rules',
'runpathdirs',
'runtime',
'shaderassembler',
'shaderassembleroutput',
'shaderdefines',
'shaderentry',
'shaderheaderfileoutput',
'shaderincludedirs',
'shadermodel',
'shaderobjectfileoutput',
'shaderoptions',
'shadertype',
'shadervariablename',
'sharedlibtype',
'startproject',
'staticruntime',
'stl',
'strictaliasing',
'stringimportdirs',
'stringpooling',
'structmemberalign',
'swiftversion',
'symbols',
'symbolspath',
'sysincludedirs',
@ -215,14 +255,20 @@ module.exports = {
'system',
'systemversion',
'tags',
'tailcalls',
'targetdir',
'targetextension',
'targetname',
'targetprefix',
'targetsuffix',
'thumbmode',
'toolchainversion',
'toolset',
'toolsversion',
'transition',
'undefines',
'unsignedchar',
'usefullpaths',
'usingdirs',
'uuid',
'vectorextensions',
@ -233,7 +279,9 @@ module.exports = {
'warnings',
'workspace',
'xcodebuildresources',
'xcodebuildsettings'
'xcodebuildsettings',
'xcodecodesigningidentity',
'xcodesystemcapabilities'
]
},
{