Skip to content

Commit a797665

Browse files
lolrobbe2lolrobbe2
committed
fix: updated docs styling for allmodulespublic -> customtoolnamespace (A-C)
1 parent f1ae17d commit a797665

38 files changed

+414
-163
lines changed

‎website/docs/allmodulespublic.md‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,21 @@
1-
allmodulespublic
1+
---
2+
title: allmodulespublic
3+
description: "Controls whether all C++ modules in the project are exported as public modules."
4+
keywords: [premake,visual studio,modules,public]
5+
---
6+
7+
Controls whether all C++ modules in the project are exported as public modules.
28

39
```lua
410
allmodulespublic "value"
511
```
612

713
### Parameters ###
814

9-
`value` one of:
10-
* `On` - All C++ modules in the given project(s) will be public.
11-
* `Off` - Not all C++ modules in the given project(s) will be public.
15+
| value | Description |
16+
| ----- | ------------------------------------------------------------- |
17+
| On | All C++ modules in the given project(s) will be public. |
18+
| Off | Not all C++ modules in the given project(s) will be public.[] |
1219

1320
## Applies To ###
1421

‎website/docs/androidapilevel.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,18 @@
1+
---
2+
title: androidapilevel
3+
keywords: [premake, android, api, level, config]
4+
description: Specifies the target Android API level.
5+
---
6+
17
Specifies the target Android API level.
28

39
```lua
4-
androidapilevel (value)
10+
androidapilevel(level)
511
```
612

713
### Parameters ###
814

9-
`value` is a number specifying the target Android API level.
15+
`level` **number** - is a number specifying the target Android API level.
1016

1117
## Applies To ###
1218

‎website/docs/androidapplibname.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
1+
---
2+
title: androidapplibname
3+
description: Specfies the file name for the output APK.
4+
keywords: [premake, android, apk, filename, config]
5+
---
6+
17
Specfies the file name for the output APK.
28

39
```lua
4-
androidapplibname ("value")
10+
androidapplibname ("filename")
511
```
612

713
By default, the project name will be used as the file name for the APK.
814

915
### Parameters ###
1016

11-
`value` is the new file name.
17+
`filename` **string** - is the new file name.
1218

1319
## Applies To ###
1420

‎website/docs/architecture.md‎

Lines changed: 34 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,47 @@
1+
---
2+
title: architecture
3+
description: Specifies the system architecture to be targeted by the configuration.
4+
keywords: [premake, architecture, system, config, x86, x86_64, arm, arm64, riscv64, wasm]
5+
---
6+
17
Specifies the system architecture to be targeted by the configuration.
28

39
```lua
4-
architecture ("value")
10+
architecture ("arch")
511
```
612

713
### Parameters ###
814

9-
`value` is one of:
10-
11-
* `universal`: The universal binaries supported by iOS and macOS
12-
* `x86`
13-
* `x86_64`
14-
* `ARM`
15-
* `ARM64`
16-
* `RISCV64`
17-
* `loongarch64`
18-
* `ppc`
19-
* `ppc64`
20-
* `wasm32`,
21-
* `wasm64`,
22-
* `e2k`,
23-
* `mips64el`,
24-
* `armv5`: Only supported in VSAndroid projects
25-
* `armv7`: Only supported in VSAndroid projects
26-
* `aarch64`: Only supported in VSAndroid projects
27-
* `mips`: Only supported in VSAndroid projects
28-
* `mips64`: Only supported in VSAndroid projects
15+
| Arch | Description |
16+
|-------------|--------------------------------------------------|
17+
| universal | Universal binaries supported by iOS and macOS |
18+
| x86 | 32-bit x86 architecture |
19+
| x86_64 | 64-bit x86 architecture |
20+
| ARM | 32-bit ARM architecture |
21+
| ARM64 | 64-bit ARM architecture |
22+
| RISCV64 | 64-bit RISC-V architecture |
23+
| loongarch64 | 64-bit LoongArch architecture |
24+
| ppc | 32-bit PowerPC architecture |
25+
| ppc64 | 64-bit PowerPC architecture |
26+
| wasm32 | 32-bit WebAssembly target |
27+
| wasm64 | 64-bit WebAssembly target |
28+
| e2k | Elbrus 2000 architecture |
29+
| mips64el | 64-bit MIPS little-endian architecture |
30+
| armv5 | ARMv5 (only supported in VSAndroid projects) |
31+
| armv7 | ARMv7 (only supported in VSAndroid projects) |
32+
| aarch64 | AArch64 (only supported in VSAndroid projects) |
33+
| mips | MIPS (only supported in VSAndroid projects) |
34+
| mips64 | 64-bit MIPS (only supported in VSAndroid projects) |
2935

3036
Additional values that are aliases for the above:
3137

32-
* `i386`: Alias for `x86`
33-
* `amd64`: Alias for `x86_64`
34-
* `x32`: Alias for `x86`; There is intent to deprecate this
35-
* `x64`: Alias for `x86_64`; There is intent to deprecate this
38+
| arch | Description |
39+
|-------|-----------------------------------------------|
40+
| i386 | Alias for `x86` |
41+
| amd64 | Alias for `x86_64` |
42+
| x32 | Alias for `x86`; there is intent to deprecate |
43+
| x64 | Alias for `x86_64`; there is intent to deprecate |
44+
3645

3746
### Applies To ###
3847

‎website/docs/assemblydebug.md‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,18 @@
1-
assemblydebug - This page was auto-generated. Feel free to help us improve the documentation by creating a pull request.
1+
---
2+
title: assemblydebug
3+
description: Generates assembly-level debug information in Visual Studio projects
4+
keywords: [premake, assemblydebug, visual studio, debug, config]
5+
---
6+
7+
Generates assembly-level debug information in Visual Studio projects
28

39
```lua
4-
assemblydebug (value)
10+
assemblydebug(enable)
511
```
612

713
### Parameters ###
814

9-
`value` - needs documentation.
15+
`enable` **boolean** - enable/disable assemblydebug.
1016

1117
## Applies To ###
1218

@@ -19,6 +25,6 @@ Premake 5.0.0 alpha 16 or later.
1925
### Examples ###
2026

2127
```lua
22-
assemblydebug (value)
28+
assemblydebug(true)
2329
```
2430

‎website/docs/atl.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: atl
3+
description: Enables Microsoft's Active Template Library in a project.
4+
keywords: [premake, atl, active template library, visual studio, project, config]
5+
---
6+
17
Enables Microsoft's Active Template Library in a project.
28

39
```lua

‎website/docs/basedir.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
1+
---
2+
title: basedir
3+
description: Sets the base directory for a configuration
4+
keywords: [premake, basedir, base directory, path, configuration]
5+
---
6+
17
Sets the base directory for a configuration, from with other paths contained by the configuration will be made relative at export time.
28

39
```lua
4-
basedir ("value")
10+
basedir ("path")
511
```
612

713
You do not normally need to set this value, as it is filled in automatically with the current working directory at the time the configuration block is created by the script.
814

915
### Parameters ###
1016

11-
`value` is an absolute path, from which other paths contained by the configuration should be made relative.
17+
`path` **string** - is an absolute path, from which other paths contained by the configuration should be made relative.
1218

1319
### Applies To ###
1420

‎website/docs/bindirs.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: bindirs
3+
description: Specifies extra paths to use when executing build commands
4+
keywords: [premake, bindirs, build commands, executable paths, config]
5+
---
6+
17
Specifies extra paths to use when executing build commands
28

39
```lua
@@ -6,7 +12,7 @@ bindirs { "directories" }
612

713
### Parameters ###
814

9-
`directories` - paths containing executable to run when building command.
15+
`directories` **string[]** - paths containing executable to run when building command.
1016

1117
### Applies To ###
1218

‎website/docs/buildaction.md‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: buildaction
3+
description: Specifies how a file or set of files should be treated during the compilation process
4+
keywords: [premake, buildaction, msbuild, visual studio, compile, embed, copy, resource, config]
5+
---
6+
17
Specifies how a file or set of files should be treated during the compilation process. It is usually paired with a filter to select a file set. If no build action is specified for a file a default action will be used, based on the file's extension.
28

39
```lua
@@ -23,8 +29,10 @@ For C/C++, `action` is the name of the MSBuild action as defined by the vcxproj
2329
| AppxManifest | Treat the file as AppX Manifest; required for UWP applications. |
2430
| Copy | Copy the file to the target directory. |
2531

32+
:::warning
2633
For C# projects, `buildaction` behaviour is special to support legacy implementation.
2734
In C#, `action` is one of
35+
:::
2836

2937
| Action | Description |
3038
|-------------|-----------------------------------------------------------------------|
@@ -38,8 +46,9 @@ In C#, `action` is one of
3846
| Resource | Copy/embed the file with the project resources. |
3947
| UserControl | Treat the source file as [visual user control][2]. |
4048

49+
:::warning
4150
The descriptive actions such as **Component**, **Form*, and **UserControl** are only recognized by Visual Studio, and may be considered optional as Visual Studio will automatically deduce the types when it first examines the project. You only need to specify these actions to avoid unnecessary modifications to the project files on save.
42-
51+
:::
4352
### Applies To ###
4453

4554
File configurations.

‎website/docs/buildcommands.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: buildcommands
3+
description: Specifies one or more shell commands to be executed to build a project or file
4+
keywords: [premake, buildcommands, shell, makefile, custom, config]
5+
---
6+
17
Specifies one or more shell commands to be executed to build a project or file.
28

39
```lua
@@ -6,7 +12,7 @@ buildcommands { "commands" }
612

713
### Parameters ###
814

9-
`commands` specifies a list of one or more shell commands to be executed. The commands may use [tokens](Tokens.md).
15+
`commands` **string[]** - specifies a list of one or more shell commands to be executed. The commands may use [tokens](Tokens.md).
1016

1117
### Applies To ###
1218

0 commit comments

Comments
 (0)