Documentation coverage¶
Field descriptions are authored as // comments in AbilityEditor/Src/AbilityEditor/Classes/AE_DataStructures.uc and flow into schema.json and these pages. See Adding an editor for where the comment goes - it is above the value var, not the Set guard.
Where things stand¶
| Measure | Described | Total | Coverage |
|---|---|---|---|
| Unique config keys | 519 | 519 | 100% |
| Rendered table rows | 6369 | 6369 | 100% |
The two rows differ because inheritance is flattened: a field on X2AbilityEffectsEditor is rendered for every effect class that inherits it. Writing one comment can therefore document dozens of rows, which is why the unique-key count is the number worth tracking.
By family¶
| Family | Unique keys | Described | Coverage |
|---|---|---|---|
| Costs | 19 | 19 | 100% |
| Cooldown | 5 | 5 | 100% |
| Charges | 3 | 3 | 100% |
| Effects | 299 | 299 | 100% |
| Conditions | 124 | 124 | 100% |
| ToHitCalc | 23 | 23 | 100% |
| TargetStyle | 10 | 10 | 100% |
| MultiTargetStyle | 34 | 34 | 100% |
| Triggers | 9 | 9 | 100% |
Highest-value keys still undescribed¶
Ordered by how many rendered rows each one would fix.
Everything is described.