You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/for-contributors/Generator/generator-mods.md
+41-1Lines changed: 41 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,6 +36,13 @@ In particular, config options and specific implementation details are omitted he
36
36
provides the information in a more clear format with less chance of being outdated. However, high level design decisions
37
37
will be documented here.
38
38
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
+
39
46
### AddApiProfiles
40
47
41
48
### AddIncludes
@@ -56,14 +63,35 @@ will be documented here.
56
63
57
64
### ExtractNestedTyping
58
65
66
+
Name affix categories:
67
+
68
+
-`FunctionPointerDelegateType` - TODO (TODO: Indicate whether it is usually a suffix or prefix)
69
+
59
70
### IdentifySharedPrefixes
60
71
72
+
Name affix categories:
73
+
74
+
-`SharedPrefix` - TODO
75
+
61
76
### InterceptNativeFunctions
62
77
78
+
Name affix categories:
79
+
80
+
-`InterceptedFunction` - TODO
81
+
63
82
### MarkNativeNames
64
83
65
84
### MixKhronosData
66
85
86
+
Name affix categories:
87
+
88
+
-`KhronosFunctionDataType` - TODO
89
+
-`KhronosHandleType` - TODO
90
+
-`KhronosImpliedVendor` - TODO
91
+
-`KhronosNamespaceEnum` - TODO
92
+
-`KhronosNonExclusiveVendor` - TODO
93
+
-`KhronosVendor` - TODO
94
+
67
95
### PrettifyNames
68
96
69
97
### StripAttributes
@@ -72,12 +100,24 @@ will be documented here.
72
100
73
101
### TransformFunctions
74
102
103
+
Name affix categories:
104
+
105
+
-`RawFunction` - TODO
106
+
75
107
### TransformHandles
76
108
109
+
Name affix categories:
110
+
111
+
-`HandleType` - TODO
112
+
77
113
### TransformProperties
78
114
79
115
(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))
80
116
81
-
### Affix Categories
117
+
## Mod Categories
118
+
119
+
(TODO)
120
+
121
+
## Name Affix Categories
82
122
83
123
(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