Skip to content

Commit 5462a83

Browse files
committed
List out the name affix categories and work on outlining the rest of the docs
1 parent ad2cb1f commit 5462a83

1 file changed

Lines changed: 41 additions & 1 deletion

File tree

docs/for-contributors/Generator/generator-mods.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,13 @@ In particular, config options and specific implementation details are omitted he
3636
provides the information in a more clear format with less chance of being outdated. However, high level design decisions
3737
will be documented here.
3838

39+
Standardized sections:
40+
41+
- **Mod categories** - Assigns a category to the mod and is purely for documentation purposes. This allows for easy
42+
searching for related mods and is used in a later section to provide recommendations relating to those mod categories.
43+
44+
- **Name affix categories** - Lists the name affix categories that the mod adds.
45+
3946
### AddApiProfiles
4047

4148
### AddIncludes
@@ -56,14 +63,35 @@ will be documented here.
5663

5764
### ExtractNestedTyping
5865

66+
Name affix categories:
67+
68+
- `FunctionPointerDelegateType` - TODO (TODO: Indicate whether it is usually a suffix or prefix)
69+
5970
### IdentifySharedPrefixes
6071

72+
Name affix categories:
73+
74+
- `SharedPrefix` - TODO
75+
6176
### InterceptNativeFunctions
6277

78+
Name affix categories:
79+
80+
- `InterceptedFunction` - TODO
81+
6382
### MarkNativeNames
6483

6584
### MixKhronosData
6685

86+
Name affix categories:
87+
88+
- `KhronosFunctionDataType` - TODO
89+
- `KhronosHandleType` - TODO
90+
- `KhronosImpliedVendor` - TODO
91+
- `KhronosNamespaceEnum` - TODO
92+
- `KhronosNonExclusiveVendor` - TODO
93+
- `KhronosVendor` - TODO
94+
6795
### PrettifyNames
6896

6997
### StripAttributes
@@ -72,12 +100,24 @@ will be documented here.
72100

73101
### TransformFunctions
74102

103+
Name affix categories:
104+
105+
- `RawFunction` - TODO
106+
75107
### TransformHandles
76108

109+
Name affix categories:
110+
111+
- `HandleType` - TODO
112+
77113
### TransformProperties
78114

79115
(TODO: Add a section for each mod and explain what they do at a high level. Also provide examples of the transformations done. Also link to where more information can be obtained (source code, test cases))
80116

81-
### Affix Categories
117+
## Mod Categories
118+
119+
(TODO)
120+
121+
## Name Affix Categories
82122

83123
(TODO: Don't keep this as its own section, but for each mod, explain the affix categories that the mod adds. Provide examples on what the affixes look like and how they should be configured in `generator.json`)

0 commit comments

Comments
 (0)