Document Existing GameTest API

[BartTerpstra1]

document the api because the current documentation is a post-it note with most of the words missing.

mojang dev explaining system: https://www.youtube.com/watch?v=vXaWOJTCYNg original PR exposing feature: https://github.com/FabricMC/fabric/pull/1622 very helpful /s wiki page: https://fabricmc.net/wiki/tutorial:gametest forge javadoc: https://nekoyue.github.io/ForgeJavaDocs-NG/javadoc/1.18.1/net/minecraft/gametest/framework/package-summary.html fabric javadoc: https://maven.fabricmc.net/docs/fabric-api-0.45.0+1.18/net/fabricmc/fabric/api/gametest/v1/package-summary.html

you can do this by adding javadoc in the QSL module we are trying to develop, writing a guide in the docs here and adding java doc to quilt-mappings, the thing that adds javadoc to minecraft decompiled source.

[BartTerpstra1]

checking minecraft mappings of net.minecraft.test, it seems only the annotations have javadocs.

[BartTerpstra1]

• [ ] add proper javadoc to quilt-mappings for net.minecraft.test by reverse engineering what they do
• [ ] get someone to proof read it and pull it
• [ ] make a second copy here in a more "how to use" oriented way

[BartTerpstra1]

• [x] AfterBatch
• [x] BeforeBatch
• [x] CustomTestProvider
• [x] FailureLoggingTestCompletionListener
• [x] GameTest
• [ ] GameTestBatch
• [ ] GameTestException
• [ ] GameTestState
• [x] NotEnoughSuccessesError
• [ ] PositionedException
• [ ] StructureTestListener
• [ ] StructureTestUtil
• [x] TeamCityTestCompletionListener
• [x] TestCompletionListener
• [ ] TestContext
• [x] TestFailureLogger
• [ ] TestFunction
• [ ] TestFunctions
• [ ] TestListener
• [ ] TestManager
• [ ] TestRunner
• [ ] TestServer
• [ ] TestSet
• [ ] TestUtil
• [ ] TickLimitExceededException
• [ ] TimedTask
• [ ] TimedTaskRunner
• [x] XmlReportingTestCompletionListener

[BartTerpstra1]

• [ ] Test command 💀