Skip to content
This repository has been archived by the owner on Feb 15, 2022. It is now read-only.

Document Existing GameTest API #2

Open
BartTerpstra1 opened this issue Dec 28, 2021 · 4 comments
Open

Document Existing GameTest API #2

BartTerpstra1 opened this issue Dec 28, 2021 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@BartTerpstra1
Copy link
Collaborator

BartTerpstra1 commented Dec 28, 2021

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:
FabricMC/fabric#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 BartTerpstra1 added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Dec 28, 2021
@BartTerpstra1 BartTerpstra1 added this to the Vanilla Useable milestone Dec 28, 2021
@BartTerpstra1 BartTerpstra1 self-assigned this Dec 28, 2021
@BartTerpstra1
Copy link
Collaborator Author

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

@BartTerpstra1
Copy link
Collaborator Author

  • 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
Copy link
Collaborator Author

BartTerpstra1 commented Dec 29, 2021

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

@BartTerpstra1
Copy link
Collaborator Author

  • Test command 💀

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant