Skip to content

Conversation

@WaitingIdly
Copy link
Collaborator

@WaitingIdly WaitingIdly commented Nov 27, 2025

changes in this PR:

  • add the ability to overwrite or add custom doc and example generation:
    • document vanilla and in-world-crafting via docgen.
    • generate documentation for preInit content (vanilla, mekanism, prodigytech).
    • add a lot of comments for this.
  • add the ability to generate descriptions for recipe builder methods (in-line comment) and recipe builder return methods (replaces old text).
  • sort methods more consistently.
  • make VALUE generate before everything else.
  • fix some typos and make some cosmetic changes to the generation:
    • move generated examples to {stage}/generated and rename them to {id}_generated.groovy.
    • update the code displaying the identifier so its sorted better, inside an admonition, and collapsed if too long.
    • change log.info to just log
    • fix a few instances of placeholdername being used instead of groovyscriptdev.
    • change tulp to tulip.
    • fix some whitespace issues where excess newlines were printed.
    • indent examples using square braces [ by a single space in some situations so it aligns better.
  • improve some internal logic:
    • allow annotations targeting methods to target any number of methods instead of only one.
    • make @RegistryDescription#location use LoadStage instead of a name.
    • add Category.CUSTOM which reads from lang keys instead (+will generate warnings if lang keys are missing) for custom categories on the wiki.
    • add ContainerHolder to hold a lot of the logic and allow customization.
    • add Heading and LinkIndex to help generate markdown index files easier.
    • only log missing keys once.
    • sort classes prior to logging classes that were not documented.
  • modify some preexisting methods and logic:
    • add setFillSound and setEmptySound to GroovyFluid instead of setSound(SoundEvent, SoundEvent), and isFinite to modify finiteFluidBlock (was previously unmodifiable).
    • change the PistonPush check from this.maxConversionsPerPush < 0 to this.maxConversionsPerPush <= 0, since 0 is also invalid
    • change Empowerer#color(float...) to color(float, float, float) and remove if (length != 3) warn!. also replace the awt color class with direct bitwise operations.
    • change Chisel#setSound from VALUE to ADDITION.
    • change MeltingRecipeBuilder not being a valid builder (when calling time tried to access fluidOutput).

@WaitingIdly WaitingIdly added the documentation Improvements or additions to documentation label Nov 27, 2025
Copy link
Member

@brachy84 brachy84 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks fine i think

@brachy84 brachy84 merged commit e0f2f91 into CleanroomMC:master Dec 10, 2025
@WaitingIdly WaitingIdly deleted the custom-docs branch December 10, 2025 20:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants