Skip to content

Commit cfce994

Browse files
committed
Attempt to write some docs for TransformFunctions
1 parent 5cf5076 commit cfce994

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
@@ -577,12 +577,24 @@ metadata is available for identifying `[Flags]` enums, consider using that inste
577577

578578
Mod categories: Transformation
579579

580+
This mod focuses on the transformation of methods, such as by changing parameters types and adding new overloads.
581+
582+
(TODO: To be expanded)
583+
584+
Notably, the transformations include transforming methods to use the Silk DSL types (`Ptr`, `Ref`, `MaybeBool`, etc).
585+
580586
Name affix categories:
581587

582-
- `RawFunction` - TODO
588+
- `RawFunction` - This is a suffix added when method overloads conflict with each other. Specifically, if a transformed
589+
version of a method differs from the original method only by return type, the *original* has the `-Raw` suffix added
590+
along with the corresponding `[NameAffix]` attribute.
583591

584592
Usage recommendations:
585593

594+
(TODO: To be expanded)
595+
596+
The `BoolTypes` property in the configuration should match the configuration used in `TransformProperties`.
597+
586598
### TransformHandles
587599

588600
Mod categories: Transformation
@@ -593,12 +605,18 @@ Name affix categories:
593605

594606
Usage recommendations:
595607

608+
(TODO: To be added)
609+
596610
### TransformProperties
597611

598612
Mod categories: Transformation
599613

600614
Usage recommendations:
601615

616+
(TODO: To be expanded)
617+
618+
The `BoolTypes` property in the configuration should match the configuration used in `TransformFunctions`.
619+
602620
## Mod Categories
603621

604622
### Creation

0 commit comments

Comments
 (0)