Skip to content

Commit 7c4ddee

Browse files
committed
Write the StripAttributes section
1 parent 5e8d600 commit 7c4ddee

1 file changed

Lines changed: 19 additions & 1 deletion

File tree

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

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -461,7 +461,7 @@ Name affix categories:
461461
implementation.
462462

463463
- `KhronosNonVendor` - This is a suffix added to any identifier that is identified to contain a suffix listed in the
464-
`NonVendorSuffixes` array of the `MixKhronosData` configuration. This is used in cases when a suffix might block the
464+
`NonVendorSuffixes` list of the `MixKhronosData` configuration. This is used in cases when a suffix might block the
465465
identification of other suffixes. For example, OpenAL has names such as `alAuxiliaryEffectSlotfDirect` where the
466466
`Direct` suffix is after the `KhronosFunctionDataType` suffix, thus blocking the `KhronosFunctionDataType` suffix
467467
from being identified. In this case, adding `Direct` as a non-vendor suffix fixes the issue. Because this is a
@@ -521,8 +521,26 @@ configured. New name affixes are also very unlikely to be introduced after the s
521521

522522
Mod categories: Metadata
523523

524+
This mod removes attributes that are listed in the `Remove` list of its config.
525+
524526
Usage recommendations:
525527

528+
This mod is intended to be used as a way to clean up intermediate metadata attributes and other attributes not
529+
particularly useful to the end user of the generated bindings.
530+
531+
These are attributes removed in Silk's own bindings:
532+
533+
- `NameAffix` - Metadata attribute used to store name affix information. Introduced by various mods.
534+
535+
- `NativeTypeName` - Metadata attribute used to store native type information. Introduced by `ClangScraper`.
536+
537+
- `Transformed` - Metadata attribute used to denote that an API is a transformed variant of another API. Introduced by
538+
various mods.
539+
540+
Tip: When debugging the name processing pipeline, disabling the `StripAttributes` mod (or just removing the
541+
`[NameAffix]` attribute from the list of attributes to be removed) can be helpful. Disabling the stripping of other
542+
attributes can also be helpful for this or other purposes.
543+
526544
### TransformEnums
527545

528546
Mod categories: Transformation

0 commit comments

Comments
 (0)