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:
parent
50051b9589
commit
0fb9327993
7
.github/workflows/ci-workflow.yml
vendored
7
.github/workflows/ci-workflow.yml
vendored
@ -16,6 +16,8 @@ jobs:
|
|||||||
run: make -f Bootstrap.mak linux PLATFORM=${{ matrix.platform }} CONFIG=${{ matrix.config }}
|
run: make -f Bootstrap.mak linux PLATFORM=${{ matrix.platform }} CONFIG=${{ matrix.config }}
|
||||||
- name: Test
|
- name: Test
|
||||||
run: bin/${{ matrix.config }}/premake5 test --test-all
|
run: bin/${{ matrix.config }}/premake5 test --test-all
|
||||||
|
- name: Docs check
|
||||||
|
run: bin/${{ matrix.config }}/premake5 docs-check
|
||||||
- name: Upload Artifacts
|
- name: Upload Artifacts
|
||||||
if: matrix.config == 'release'
|
if: matrix.config == 'release'
|
||||||
uses: actions/upload-artifact@v2
|
uses: actions/upload-artifact@v2
|
||||||
@ -35,6 +37,8 @@ jobs:
|
|||||||
run: make -f Bootstrap.mak macosx PLATFORM=${{ matrix.platform }} CONFIG=${{ matrix.config }}
|
run: make -f Bootstrap.mak macosx PLATFORM=${{ matrix.platform }} CONFIG=${{ matrix.config }}
|
||||||
- name: Test
|
- name: Test
|
||||||
run: bin/${{ matrix.config }}/premake5 test --test-all
|
run: bin/${{ matrix.config }}/premake5 test --test-all
|
||||||
|
- name: Docs check
|
||||||
|
run: bin/${{ matrix.config }}/premake5 docs-check
|
||||||
- name: Upload Artifacts
|
- name: Upload Artifacts
|
||||||
if: matrix.config == 'release'
|
if: matrix.config == 'release'
|
||||||
uses: actions/upload-artifact@v2
|
uses: actions/upload-artifact@v2
|
||||||
@ -58,6 +62,9 @@ jobs:
|
|||||||
- name: Test
|
- name: Test
|
||||||
run: bin\${{ matrix.config }}\premake5 test --test-all
|
run: bin\${{ matrix.config }}\premake5 test --test-all
|
||||||
shell: cmd
|
shell: cmd
|
||||||
|
- name: Docs check
|
||||||
|
run: bin\${{ matrix.config }}\premake5 docs-check
|
||||||
|
shell: cmd
|
||||||
- name: Upload Artifacts
|
- name: Upload Artifacts
|
||||||
if: matrix.config == 'release'
|
if: matrix.config == 'release'
|
||||||
uses: actions/upload-artifact@v2
|
uses: actions/upload-artifact@v2
|
||||||
|
@ -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 {
|
newaction {
|
||||||
trigger = "test",
|
trigger = "test",
|
||||||
description = "Run the automated test suite",
|
description = "Run the automated test suite",
|
||||||
|
14
scripts/docscheck.lua
Normal file
14
scripts/docscheck.lua
Normal 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)
|
@ -19,6 +19,6 @@ Many of the old [`flags`](flags.md) have become full-fledged functions. This sho
|
|||||||
| `FloatFast`, `FloatStrict` | [`floatingpoint`](floatingpoint.md) |
|
| `FloatFast`, `FloatStrict` | [`floatingpoint`](floatingpoint.md) |
|
||||||
| `Managed`, `Unsafe` | [`clr`](clr.md) |
|
| `Managed`, `Unsafe` | [`clr`](clr.md) |
|
||||||
| `NativeWChar` | [`nativewchar`](nativewchar.md) |
|
| `NativeWChar` | [`nativewchar`](nativewchar.md) |
|
||||||
| `NoEditAndContinue` | [`editandcontinue`](editAndContinue.md) |
|
| `NoEditAndContinue` | [`editandcontinue`](editandcontinue.md) |
|
||||||
| `NoRTTI` | [`rtti`](rtti.md) |
|
| `NoRTTI` | [`rtti`](rtti.md) |
|
||||||
| `OptimizeSize`, `OptimizeSpeed` | [`optimize`](optimize.md) |
|
| `OptimizeSize`, `OptimizeSpeed` | [`optimize`](optimize.md) |
|
||||||
|
@ -69,7 +69,7 @@
|
|||||||
| [display](display.md) | |
|
| [display](display.md) | |
|
||||||
| [docdir](docdir.md) | |
|
| [docdir](docdir.md) | |
|
||||||
| [docname](docname.md) | |
|
| [docname](docname.md) | |
|
||||||
| [editandcontinue](editAndContinue.md) | |
|
| [editandcontinue](editandcontinue.md) | |
|
||||||
| [editorintegration](editorintegration.md) | Enable or disable IDE integration |
|
| [editorintegration](editorintegration.md) | Enable or disable IDE integration |
|
||||||
| [enablewarnings](enablewarnings.md) | |
|
| [enablewarnings](enablewarnings.md) | |
|
||||||
| [endian](endian.md) | |
|
| [endian](endian.md) | |
|
||||||
|
@ -63,7 +63,7 @@ title: What's New in 5.0
|
|||||||
* [dependson](dependson.md) (new)
|
* [dependson](dependson.md) (new)
|
||||||
* [disablewarnings](disablewarnings.md) (new)
|
* [disablewarnings](disablewarnings.md) (new)
|
||||||
* [dotnetframework](dotnetframework.md) (new)
|
* [dotnetframework](dotnetframework.md) (new)
|
||||||
* [editandcontinue](editAndContinue.md) (new, replaces flag `NoEditAndContinue`)
|
* [editandcontinue](editandcontinue.md) (new, replaces flag `NoEditAndContinue`)
|
||||||
* [editorintegration](editorintegration.md) (new)
|
* [editorintegration](editorintegration.md) (new)
|
||||||
* [enablewarnings](enablewarnings.md) (new)
|
* [enablewarnings](enablewarnings.md) (new)
|
||||||
* [endian](endian.md) (new)
|
* [endian](endian.md) (new)
|
||||||
@ -151,6 +151,6 @@ title: What's New in 5.0
|
|||||||
* FloatFast, FloatStrict: use [floatingpoint](floatingpoint.md) instead
|
* FloatFast, FloatStrict: use [floatingpoint](floatingpoint.md) instead
|
||||||
* Managed, Unsafe: use [clr](clr.md) instead
|
* Managed, Unsafe: use [clr](clr.md) instead
|
||||||
* NativeWChar: use [nativewchar](nativewchar.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.
|
* NoRTTI: use [rtti](rtti.md) instead.
|
||||||
* OptimizeSize, OptimizeSpeed: use [optimize](optimize.md) instead
|
* OptimizeSize, OptimizeSpeed: use [optimize](optimize.md) instead
|
||||||
|
24
website/docs/androidapilevel.md
Normal file
24
website/docs/androidapilevel.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
24
website/docs/androidapplibname.md
Normal file
24
website/docs/androidapplibname.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
24
website/docs/assemblydebug.md
Normal file
24
website/docs/assemblydebug.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
29
website/docs/boundscheck.md
Normal file
29
website/docs/boundscheck.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
30
website/docs/checkaction.md
Normal file
30
website/docs/checkaction.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
29
website/docs/compilationmodel.md
Normal file
29
website/docs/compilationmodel.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
24
website/docs/computetargets.md
Normal file
24
website/docs/computetargets.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
24
website/docs/conformancemode.md
Normal file
24
website/docs/conformancemode.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
@ -12,7 +12,7 @@ debugformat "format"
|
|||||||
|-------------|---------------------------------------------------------------------------------------------|
|
|-------------|---------------------------------------------------------------------------------------------|
|
||||||
| c7 | Specifies that MSVC should store debuginfo in the objects rather than a separate .pdb file. |
|
| 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 ###
|
### Applies To ###
|
||||||
|
|
||||||
@ -24,5 +24,5 @@ Premake 5.0 or later.
|
|||||||
|
|
||||||
### See Also ###
|
### See Also ###
|
||||||
|
|
||||||
- [editAndContinue](editAndContinue.md)
|
- [editandcontinue](editandcontinue.md)
|
||||||
|
|
||||||
|
29
website/docs/debuggerflavor.md
Normal file
29
website/docs/debuggerflavor.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
24
website/docs/dependenciesfile.md
Normal file
24
website/docs/dependenciesfile.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
29
website/docs/deprecatedfeatures.md
Normal file
29
website/docs/deprecatedfeatures.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
@ -1,7 +1,7 @@
|
|||||||
Turns the edit-and-continue features of a toolset or platform on and off.
|
Turns the edit-and-continue features of a toolset or platform on and off.
|
||||||
|
|
||||||
```lua
|
```lua
|
||||||
editAndContinue "value"
|
editandcontinue "value"
|
||||||
```
|
```
|
||||||
|
|
||||||
If no value is set for a configuration, the toolset's default setting (usually "On") will be used.
|
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
|
```lua
|
||||||
-- Turn off edit and continue
|
-- Turn off edit and continue
|
||||||
editAndContinue "Off"
|
editandcontinue "Off"
|
||||||
```
|
```
|
||||||
|
|
||||||
### See Also ###
|
### See Also ###
|
24
website/docs/embed.md
Normal file
24
website/docs/embed.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
24
website/docs/embedandsign.md
Normal file
24
website/docs/embedandsign.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
24
website/docs/enabledefaultcompileitems.md
Normal file
24
website/docs/enabledefaultcompileitems.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
24
website/docs/fastuptodate.md
Normal file
24
website/docs/fastuptodate.md
Normal 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
28
website/docs/floatabi.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
24
website/docs/frameworkdirs.md
Normal file
24
website/docs/frameworkdirs.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
24
website/docs/importdirs.md
Normal file
24
website/docs/importdirs.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
27
website/docs/inlinesvisibility.md
Normal file
27
website/docs/inlinesvisibility.md
Normal 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
28
website/docs/iosfamily.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
36
website/docs/isaextensions.md
Normal file
36
website/docs/isaextensions.md
Normal 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
24
website/docs/jsonfile.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
28
website/docs/omitframepointer.md
Normal file
28
website/docs/omitframepointer.md
Normal 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
33
website/docs/preview.md
Normal 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
27
website/docs/revert.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
28
website/docs/shaderassembler.md
Normal file
28
website/docs/shaderassembler.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
24
website/docs/shaderassembleroutput.md
Normal file
24
website/docs/shaderassembleroutput.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
24
website/docs/shaderdefines.md
Normal file
24
website/docs/shaderdefines.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
24
website/docs/shaderentry.md
Normal file
24
website/docs/shaderentry.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
24
website/docs/shaderheaderfileoutput.md
Normal file
24
website/docs/shaderheaderfileoutput.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
24
website/docs/shaderincludedirs.md
Normal file
24
website/docs/shaderincludedirs.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
41
website/docs/shadermodel.md
Normal file
41
website/docs/shadermodel.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
24
website/docs/shaderobjectfileoutput.md
Normal file
24
website/docs/shaderobjectfileoutput.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
24
website/docs/shaderoptions.md
Normal file
24
website/docs/shaderoptions.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
36
website/docs/shadertype.md
Normal file
36
website/docs/shadertype.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
24
website/docs/shadervariablename.md
Normal file
24
website/docs/shadervariablename.md
Normal 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
30
website/docs/stl.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
24
website/docs/stringimportdirs.md
Normal file
24
website/docs/stringimportdirs.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
30
website/docs/structmemberalign.md
Normal file
30
website/docs/structmemberalign.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
28
website/docs/swiftversion.md
Normal file
28
website/docs/swiftversion.md
Normal 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
24
website/docs/tailcalls.md
Normal 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
28
website/docs/thumbmode.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
33
website/docs/toolchainversion.md
Normal file
33
website/docs/toolchainversion.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
30
website/docs/transition.md
Normal file
30
website/docs/transition.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
24
website/docs/unsignedchar.md
Normal file
24
website/docs/unsignedchar.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
24
website/docs/usefullpaths.md
Normal file
24
website/docs/usefullpaths.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
24
website/docs/xcodecodesigningidentity.md
Normal file
24
website/docs/xcodecodesigningidentity.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
24
website/docs/xcodesystemcapabilities.md
Normal file
24
website/docs/xcodesystemcapabilities.md
Normal 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)
|
||||||
|
```
|
||||||
|
|
@ -60,10 +60,14 @@ module.exports = {
|
|||||||
type: 'category',
|
type: 'category',
|
||||||
label: 'Project Settings',
|
label: 'Project Settings',
|
||||||
items: [
|
items: [
|
||||||
|
'androidapilevel',
|
||||||
|
'androidapplibname',
|
||||||
'architecture',
|
'architecture',
|
||||||
|
'assemblydebug',
|
||||||
'atl',
|
'atl',
|
||||||
'basedir',
|
'basedir',
|
||||||
'bindirs',
|
'bindirs',
|
||||||
|
'boundscheck',
|
||||||
'buildaction',
|
'buildaction',
|
||||||
'buildcommands',
|
'buildcommands',
|
||||||
'buildcustomizations',
|
'buildcustomizations',
|
||||||
@ -77,15 +81,19 @@ module.exports = {
|
|||||||
'callingconvention',
|
'callingconvention',
|
||||||
'cdialect',
|
'cdialect',
|
||||||
'characterset',
|
'characterset',
|
||||||
|
'checkaction',
|
||||||
'cleancommands',
|
'cleancommands',
|
||||||
'cleanextensions',
|
'cleanextensions',
|
||||||
'clr',
|
'clr',
|
||||||
|
'compilationmodel',
|
||||||
'compileas',
|
'compileas',
|
||||||
'compilebuildoutputs',
|
'compilebuildoutputs',
|
||||||
|
'computetargets',
|
||||||
'configfile',
|
'configfile',
|
||||||
'configmap',
|
'configmap',
|
||||||
'configuration',
|
'configuration',
|
||||||
'configurations',
|
'configurations',
|
||||||
|
'conformancemode',
|
||||||
'copylocal',
|
'copylocal',
|
||||||
'cppdialect',
|
'cppdialect',
|
||||||
'csversion',
|
'csversion',
|
||||||
@ -100,6 +108,7 @@ module.exports = {
|
|||||||
'debugextendedprotocol',
|
'debugextendedprotocol',
|
||||||
'debugformat',
|
'debugformat',
|
||||||
'debugger',
|
'debugger',
|
||||||
|
'debuggerflavor',
|
||||||
'debuggertype',
|
'debuggertype',
|
||||||
'debuglevel',
|
'debuglevel',
|
||||||
'debugpathmap',
|
'debugpathmap',
|
||||||
@ -111,8 +120,10 @@ module.exports = {
|
|||||||
'debugtoolcommand',
|
'debugtoolcommand',
|
||||||
'defaultplatform',
|
'defaultplatform',
|
||||||
'defines',
|
'defines',
|
||||||
|
'dependenciesfile',
|
||||||
'dependson',
|
'dependson',
|
||||||
'deploymentoptions',
|
'deploymentoptions',
|
||||||
|
'deprecatedfeatures',
|
||||||
'disablewarnings',
|
'disablewarnings',
|
||||||
'display',
|
'display',
|
||||||
'docdir',
|
'docdir',
|
||||||
@ -120,8 +131,11 @@ module.exports = {
|
|||||||
'dofileopt',
|
'dofileopt',
|
||||||
'dotnetframework',
|
'dotnetframework',
|
||||||
'dpiawareness',
|
'dpiawareness',
|
||||||
'editAndContinue',
|
'editandcontinue',
|
||||||
'editorintegration',
|
'editorintegration',
|
||||||
|
'embed',
|
||||||
|
'embedandsign',
|
||||||
|
'enabledefaultcompileitems',
|
||||||
'enablewarnings',
|
'enablewarnings',
|
||||||
'endian',
|
'endian',
|
||||||
'entrypoint',
|
'entrypoint',
|
||||||
@ -129,18 +143,21 @@ module.exports = {
|
|||||||
'external',
|
'external',
|
||||||
'externalproject',
|
'externalproject',
|
||||||
'externalrule',
|
'externalrule',
|
||||||
|
'fastuptodate',
|
||||||
'fatalwarnings',
|
'fatalwarnings',
|
||||||
'fileextension',
|
'fileextension',
|
||||||
'filename',
|
'filename',
|
||||||
'files',
|
'files',
|
||||||
'filter',
|
'filter',
|
||||||
'flags',
|
'flags',
|
||||||
|
'floatabi',
|
||||||
'floatingpoint',
|
'floatingpoint',
|
||||||
'floatingpointexceptions',
|
'floatingpointexceptions',
|
||||||
'forceincludes',
|
'forceincludes',
|
||||||
'forceusings',
|
'forceusings',
|
||||||
'fpu',
|
'fpu',
|
||||||
'framework',
|
'framework',
|
||||||
|
'frameworkdirs',
|
||||||
'functionlevellinking',
|
'functionlevellinking',
|
||||||
'gccprefix',
|
'gccprefix',
|
||||||
'group',
|
'group',
|
||||||
@ -155,9 +172,14 @@ module.exports = {
|
|||||||
'implibname',
|
'implibname',
|
||||||
'implibprefix',
|
'implibprefix',
|
||||||
'implibsuffix',
|
'implibsuffix',
|
||||||
|
'importdirs',
|
||||||
'includedirs',
|
'includedirs',
|
||||||
|
'inlinesvisibility',
|
||||||
'inlining',
|
'inlining',
|
||||||
'intrinsics',
|
'intrinsics',
|
||||||
|
'iosfamily',
|
||||||
|
'isaextensions',
|
||||||
|
'jsonfile',
|
||||||
'justmycode',
|
'justmycode',
|
||||||
'kind',
|
'kind',
|
||||||
'language',
|
'language',
|
||||||
@ -177,6 +199,7 @@ module.exports = {
|
|||||||
'nuget',
|
'nuget',
|
||||||
'nugetsource',
|
'nugetsource',
|
||||||
'objdir',
|
'objdir',
|
||||||
|
'omitframepointer',
|
||||||
'openmp',
|
'openmp',
|
||||||
'optimize',
|
'optimize',
|
||||||
'pchheader',
|
'pchheader',
|
||||||
@ -190,6 +213,7 @@ module.exports = {
|
|||||||
'preferredtoolarchitecture',
|
'preferredtoolarchitecture',
|
||||||
'prelinkcommands',
|
'prelinkcommands',
|
||||||
'prelinkmessage',
|
'prelinkmessage',
|
||||||
|
'preview',
|
||||||
'project',
|
'project',
|
||||||
'propertydefinition',
|
'propertydefinition',
|
||||||
'rebuildcommands',
|
'rebuildcommands',
|
||||||
@ -198,16 +222,32 @@ module.exports = {
|
|||||||
'resincludedirs',
|
'resincludedirs',
|
||||||
'resoptions',
|
'resoptions',
|
||||||
'resourcegenerator',
|
'resourcegenerator',
|
||||||
|
'revert',
|
||||||
'rtti',
|
'rtti',
|
||||||
'rule',
|
'rule',
|
||||||
'rules',
|
'rules',
|
||||||
'runpathdirs',
|
'runpathdirs',
|
||||||
'runtime',
|
'runtime',
|
||||||
|
'shaderassembler',
|
||||||
|
'shaderassembleroutput',
|
||||||
|
'shaderdefines',
|
||||||
|
'shaderentry',
|
||||||
|
'shaderheaderfileoutput',
|
||||||
|
'shaderincludedirs',
|
||||||
|
'shadermodel',
|
||||||
|
'shaderobjectfileoutput',
|
||||||
|
'shaderoptions',
|
||||||
|
'shadertype',
|
||||||
|
'shadervariablename',
|
||||||
'sharedlibtype',
|
'sharedlibtype',
|
||||||
'startproject',
|
'startproject',
|
||||||
'staticruntime',
|
'staticruntime',
|
||||||
|
'stl',
|
||||||
'strictaliasing',
|
'strictaliasing',
|
||||||
|
'stringimportdirs',
|
||||||
'stringpooling',
|
'stringpooling',
|
||||||
|
'structmemberalign',
|
||||||
|
'swiftversion',
|
||||||
'symbols',
|
'symbols',
|
||||||
'symbolspath',
|
'symbolspath',
|
||||||
'sysincludedirs',
|
'sysincludedirs',
|
||||||
@ -215,14 +255,20 @@ module.exports = {
|
|||||||
'system',
|
'system',
|
||||||
'systemversion',
|
'systemversion',
|
||||||
'tags',
|
'tags',
|
||||||
|
'tailcalls',
|
||||||
'targetdir',
|
'targetdir',
|
||||||
'targetextension',
|
'targetextension',
|
||||||
'targetname',
|
'targetname',
|
||||||
'targetprefix',
|
'targetprefix',
|
||||||
'targetsuffix',
|
'targetsuffix',
|
||||||
|
'thumbmode',
|
||||||
|
'toolchainversion',
|
||||||
'toolset',
|
'toolset',
|
||||||
'toolsversion',
|
'toolsversion',
|
||||||
|
'transition',
|
||||||
'undefines',
|
'undefines',
|
||||||
|
'unsignedchar',
|
||||||
|
'usefullpaths',
|
||||||
'usingdirs',
|
'usingdirs',
|
||||||
'uuid',
|
'uuid',
|
||||||
'vectorextensions',
|
'vectorextensions',
|
||||||
@ -233,7 +279,9 @@ module.exports = {
|
|||||||
'warnings',
|
'warnings',
|
||||||
'workspace',
|
'workspace',
|
||||||
'xcodebuildresources',
|
'xcodebuildresources',
|
||||||
'xcodebuildsettings'
|
'xcodebuildsettings',
|
||||||
|
'xcodecodesigningidentity',
|
||||||
|
'xcodesystemcapabilities'
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
Loading…
Reference in New Issue
Block a user