Merge pull request #1715 from KyrietS/docs-maintenance
Docs maintenance
This commit is contained in:
Kyriet
GitHub
commit
38ccc25826
@ -14,7 +14,7 @@ If you think something should be possible and you can't figure out how to do it,
|
||||
| Locate include files | [includedirs](includedirs.md) |
|
||||
| Set up precompiled headers | [pchheader](pchheader.md), [pchsource](pchsource.md) |
|
||||
| Link libraries, frameworks, or other projects | [links](links.md), [libdirs](libdirs.md) |
|
||||
| Enable debugging information | symbols(symbols) |
|
||||
| Enable debugging information | [symbols](symbols.md) |
|
||||
| Optimize for size or speed | [optimize](optimize.md) |
|
||||
| Add arbitrary build flags | [buildoptions](buildoptions.md), [linkoptions](linkoptions.md) |
|
||||
| Set the name or location of compiled targets | [targetname](targetname.md), [targetdir](targetdir.md) |
|
||||
|
||||
@ -8,12 +8,10 @@ callingconvention ("value")
|
||||
|
||||
`value` is one of:
|
||||
|
||||
| |
|
||||
|-------------|
|
||||
| Cdecl |
|
||||
| FastCall |
|
||||
| StdCall |
|
||||
| VectorCall |
|
||||
* `Cdecl`
|
||||
* `FastCall`
|
||||
* `StdCall`
|
||||
* `VectorCall`
|
||||
|
||||
### Applies To ###
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ exceptionhandling ("value")
|
||||
|
||||
`value` is one of:
|
||||
|
||||
| | |
|
||||
| Value | Description |
|
||||
|---------|---------------------------------------------------|
|
||||
| Default | Use the toolset's default setting for exceptions. |
|
||||
| On | Turn on exceptions. |
|
||||
|
||||
@ -8,7 +8,7 @@ inlining ("value")
|
||||
|
||||
`value` is one of:
|
||||
|
||||
| | |
|
||||
| Value | Description |
|
||||
|-----------|--------------------------------------------------------------------|
|
||||
| Default | Allow the compiler to use its default inlining behavior. |
|
||||
| Disabled | Turn off inlining entirely. |
|
||||
|
||||
@ -8,7 +8,7 @@ newaction { description }
|
||||
|
||||
`description` is a table describing the new action. It may contain the following fields:
|
||||
|
||||
| | |
|
||||
| Field | Description |
|
||||
|-------------|------------------------------------------------------------------------------------|
|
||||
| trigger | What the user would type on the command line to select the action, e.g. "vs2013". |
|
||||
| shortname | A short summary for the help text, e.g. "Visual Studio 2013". |
|
||||
|
||||
@ -8,7 +8,7 @@ newoption { description }
|
||||
|
||||
`description` is a table describing the new option. It may contain the following fields:
|
||||
|
||||
| | |
|
||||
| Field | Description |
|
||||
|-------------|------------------------------------------------------------------------------------|
|
||||
| trigger | What the user would type on the command line to select the option, e.g. "--name". |
|
||||
| description | A short description of the option, to be displayed in the help text. |
|
||||
|
||||
@ -6,7 +6,7 @@ p = os.findlib("libname" [, additionalpaths])
|
||||
|
||||
### Parameters ###
|
||||
|
||||
`libname` is name of the library to locate. It may be specified with (libX11.so.md) or without (X11) system-specific decorations.
|
||||
`libname` is name of the library to locate. It may be specified with (libX11.so) or without (X11) system-specific decorations.
|
||||
|
||||
`additionalpaths` is a string or a table of one or more additional search path
|
||||
### Return Value ###
|
||||
|
||||
@ -12,7 +12,7 @@ None.
|
||||
|
||||
A table, containing the following key-value pairs:
|
||||
|
||||
| | |
|
||||
| Field | Description |
|
||||
|---------------|---------------------------------------------------|
|
||||
| majorversion | The major version number |
|
||||
| minorversion | The minor version number |
|
||||
|
||||
@ -13,7 +13,7 @@ info = os.stat("path")
|
||||
|
||||
If successful, a table of values:
|
||||
|
||||
| | |
|
||||
| Field | Description |
|
||||
|-------|-----------------------------|
|
||||
| mtime | Last modified timestamp |
|
||||
| size | The file size in bytes |
|
||||
|
||||
@ -22,14 +22,12 @@ Required; a name for the rule that will be unique in the projects where it is us
|
||||
#### kind ####
|
||||
The expected data type of the values assigned to this property. Allowed values are:
|
||||
|
||||
| | |
|
||||
|---------|-----------------------------------|
|
||||
| boolean | A yes or no value. |
|
||||
| integer | An integer number. |
|
||||
| list | A list of string values. |
|
||||
| number | A floating point number. |
|
||||
| path | A single file system path value. |
|
||||
| string | A single string value. |
|
||||
* `boolean` - a yes or no value.
|
||||
* `integer` - an integer number.
|
||||
* `list` - a list of string values.
|
||||
* `number` - a floating point number.
|
||||
* `path` - a single file system path value.
|
||||
* `string` - a single string value.
|
||||
|
||||
For enum properties, this field is ignored and can be omitted. Otherwise it is required.
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ rtti ("value")
|
||||
|
||||
`value` is one of:
|
||||
|
||||
| | |
|
||||
| Value | Description |
|
||||
|---------|---------------------------------------------------|
|
||||
| Default | Use the toolset's default setting for run-time type information. |
|
||||
| On | Turn on RTTI. |
|
||||
|
||||
Reference in New Issue
Block a user