|
12 | 12 |
|
13 | 13 | /// Enum capturing all of the functions that can be used in an `#if` condition.
|
14 | 14 | enum IfConfigFunctions: String {
|
15 |
| - /// A check for a specific attribute. |
| 15 | + /// A check for a specific attribute via `hasAttribute(<name>)`. |
16 | 16 | case hasAttribute
|
17 | 17 |
|
18 |
| - /// A check for a specific named feature. |
| 18 | + /// A check for a specific named feature via `hasFeature(<name>)`. |
19 | 19 | case hasFeature
|
20 | 20 |
|
21 |
| - /// A check for the Swift language version. |
| 21 | + /// A check for the Swift language version via `swift(>=version).` |
22 | 22 | case swift
|
23 | 23 |
|
24 |
| - /// A check for the Swift compiler version. |
| 24 | + /// A check for the Swift compiler version via `compiler(>=version)`. |
25 | 25 | case compiler
|
26 | 26 |
|
27 |
| - /// A check to determine whether a given module can be imported. |
| 27 | + /// A check to determine whether a given module can be imported via `canImport(<import path>)`. |
28 | 28 | case canImport
|
29 | 29 |
|
30 |
| - /// A check for the target Operating System kind (e.g., Linux, iOS). |
| 30 | + /// A check for the target Operating System kind (e.g., Linux, iOS) via `os(<name>)` |
31 | 31 | case os
|
32 | 32 |
|
33 |
| - /// A check for the target architecture (e.g., arm64, x86_64). |
| 33 | + /// A check for the target architecture (e.g., arm64, x86_64) via `arch(<name>)`. |
34 | 34 | case arch
|
35 | 35 |
|
36 |
| - /// A check for the target environment (e.g., simulator). |
| 36 | + /// A check for the target environment (e.g., simulator) via `targetEnvironment(<environment>)`. |
37 | 37 | case targetEnvironment
|
38 | 38 |
|
39 |
| - /// A historical check against a specific compiler build version. |
| 39 | + /// A historical check against a specific compiler build version via `_compiler_version("<version>")`. |
40 | 40 | case _compiler_version
|
41 | 41 |
|
42 |
| - /// A check for the target endianness (e.g., big or little) |
| 42 | + /// A check for the target endianness (e.g., big or little) via `_endian(big|little)`. |
43 | 43 | case _endian
|
44 | 44 |
|
45 | 45 | /// A check for the target bit width of a pointer (e.g., _64)
|
46 | 46 | case _pointerBitWidth
|
47 | 47 |
|
48 |
| - /// A check for the target runtime paired with the Swift runtime (e.g., _ObjC). |
| 48 | + /// A check for the target runtime paired with the Swift runtime (e.g., _ObjC) |
| 49 | + /// via `_runtime(<name>)`. |
49 | 50 | case _runtime
|
50 | 51 |
|
51 |
| - /// A check for the target's pointer authentication scheme (e.g., _arm64e). |
| 52 | + /// A check for the target's pointer authentication scheme (e.g., _arm64e) |
| 53 | + /// via `_ptrauth(<name>)`. |
52 | 54 | case _ptrauth
|
53 | 55 | }
|
0 commit comments