Enhance docgen for overriding default logic (#357)

* dont log twice if flags are true

* use LoadStage enum for annotation

* remove IFormat parameter from gen wiki

* add targetFile to generateExamples

* move examples to "generated" subfolder

* generate wiki in wiki/mods folder

* add IContainerDocumentation

* change vanilla wiki to generate in separate folder

* add the ability to export files directly

* add vanilla index file to export directly

* log.info into log

* return boolean for IContainerDocumentation

* use IGroovyContainer for doc

* rename parameter to loadStage

* simplify Registry creation

* use list for inworldcrafting

* allow a single annotation to target multiple methods

* refactor recursive annotation fetching

* gather recursive annotations for RBMD/RBRM

* extract try-catch IO in Documentation, simplify

* move VALUE method examples to first

* pass lang key into builder

* consolidate logic with IRegistryDocumentation

* make default reference use global binding if exists

* adjust vanilla logic with custom container

* make vanilla register globals based on its aliases

* extract strings to constants

* apply change to vanilla minecraft postInit

* generate mekanism infusion texture

* generate preInit ZorraAltar examples

* fix piston push validation incorrectly allowing 0

* allow non-mod ContainerHolder headers

* add in-world crafting

* ensure trailing whitespace is the same in all examples

* change carving sound to ADDITION

* simplify documenting type method

* streamline compare packages

* convert example to use case insensitive

* sort example entries better

* the humble spotless apply

* delete old in_world_crafting examples

* end index file with more line breaks

* make minecraft use alias and have more of them

* rename minecraft wiki page to Vanilla Registries

* rework package block to be clearer and less spammy

* always admonition, but only collapse if too many

* switch admonition to quote

* fix vararg method ties

* rename generated files

* make inWorldCrafting have properties correctly

* deduplicate sets in a different location

* add more inworldcrafting examples

* add header control to markdown sections

* rename subtitle to comment

* note header level

* remove random unused imports

* reduce some code complexity

* document containerholder better

* add LangHelper.fallback

* replace all headers with MarkdownSection

* rename to Heading

* make header IFormat

* thats now how you make new lines

* add category header overrides

* make non-varargs translate method

* rework lang key usage for category

* adjust documenting methods

* surround mod in parentheses for title

* extract tab indent whitespace

* document content creation

* gather overrides from class

* tulip typo

* fix error not logging desired info

* add description to recipe builder methods

* reduce complexity of some field doc code

* ensure period in custom register description

* document content builders

* remove trailing newlines on index files

* sort classes that skipped documentation

* add method descriptions to more places

* fix melting recipe builder

* spotless apply

* needs two percent symbols

* move heading to constructor, split link logic

* add custom iwc description

* remove now-unused test file

* add a single space to indent better

* use priority for wiki

* minor whitespace change

* remove useless distinct call

* add more content documentation

* minor capitalization typo

Author: WaitingIdly

examples/postInit/custom/in_world_crafting.groovy

@@ -2,7 +2,7 @@
 // Auto generated groovyscript example file
 // MODS_LOADED: actuallyadditions
 
-log.info 'mod \'actuallyadditions\' detected, running script'
+log 'mod \'actuallyadditions\' detected, running script'
 
 // Atomic Reconstructor:
 // The Atomic Reconstructor is a block which uses energy to convert a block or item in front of it into other items.
@@ -120,8 +120,8 @@ mods.actuallyadditions.empowerer.recipeBuilder()
 // A weighted oredict for the block obtained via firing a Mining Lens at a block of Netherrack. The oredict must have a
 // block, or the world will hang.
 
-mods.actuallyadditions.nether_mining_lens.removeByOre(ore('oreQuartz'))
 mods.actuallyadditions.nether_mining_lens.removeByOre('oreQuartz')
+mods.actuallyadditions.nether_mining_lens.removeByOre(ore('oreQuartz'))
 // mods.actuallyadditions.nether_mining_lens.removeAll()
 
 mods.actuallyadditions.nether_mining_lens.recipeBuilder()
@@ -139,8 +139,8 @@ mods.actuallyadditions.nether_mining_lens.recipeBuilder()
 // Turns a fluid into power at a rate.
 
 mods.actuallyadditions.oil_gen.removeByInput(fluid('canolaoil').getFluid())
-mods.actuallyadditions.oil_gen.removeByInput(fluid('canolaoil'))
 mods.actuallyadditions.oil_gen.removeByInput('refinedcanolaoil')
+mods.actuallyadditions.oil_gen.removeByInput(fluid('canolaoil'))
 // mods.actuallyadditions.oil_gen.removeAll()
 
 mods.actuallyadditions.oil_gen.recipeBuilder()
@@ -160,8 +160,8 @@ mods.actuallyadditions.oil_gen.recipeBuilder()
 // A weighted oredict for the block obtained via firing a Mining Lens at a block of Stone. The oredict must have a block,
 // or the world will hang.
 
-mods.actuallyadditions.stone_mining_lens.removeByOre(ore('oreCoal'))
 mods.actuallyadditions.stone_mining_lens.removeByOre('oreLapis')
+mods.actuallyadditions.stone_mining_lens.removeByOre(ore('oreCoal'))
 // mods.actuallyadditions.stone_mining_lens.removeAll()
 
 mods.actuallyadditions.stone_mining_lens.recipeBuilder()
@@ -188,5 +188,3 @@ mods.actuallyadditions.treasure_chest.recipeBuilder()
     .min(16)
     .max(32)
     .register()
-
-

…amples/postInit/actuallyadditions.groovy …rated/actuallyadditions_generated.groovyexamples/postInit/actuallyadditions.groovy renamed to examples/postInit/generated/actuallyadditions_generated.groovy examples/postInit/actuallyadditions.groovy renamed to examples/postInit/generated/actuallyadditions_generated.groovy

@@ -2,7 +2,7 @@
 // Auto generated groovyscript example file
 // MODS_LOADED: advancedmortars
 
-log.info 'mod \'advancedmortars\' detected, running script'
+log 'mod \'advancedmortars\' detected, running script'
 
 // Mortar:
 // Uses any number of specific types of Mortars to convert multiple items into a single output with a possible chance
@@ -32,7 +32,6 @@ mods.advancedmortars.mortar.recipeBuilder()
     .register()
 
 
-mods.advancedmortars.mortar.add(['iron', 'wood'], item('minecraft:tnt') * 5, 4, item('minecraft:tnt'), 0.7, [ore('ingotIron'), ore('ingotIron'), ore('ingotIron'), ore('ingotIron'),ore('ingotIron'), ore('ingotIron'), ore('ingotIron'), ore('ingotIron')])
 mods.advancedmortars.mortar.add(['stone'], item('minecraft:tnt'), 4, [ore('ingotGold')])
 mods.advancedmortars.mortar.add(['stone'], item('minecraft:diamond') * 4, 4, [ore('ingotGold')])
-
+mods.advancedmortars.mortar.add(['iron', 'wood'], item('minecraft:tnt') * 5, 4, item('minecraft:tnt'), 0.7, [ore('ingotIron'), ore('ingotIron'), ore('ingotIron'), ore('ingotIron'),ore('ingotIron'), ore('ingotIron'), ore('ingotIron'), ore('ingotIron')])

examples/postInit/advancedmortars.groovy …nerated/advancedmortars_generated.groovyexamples/postInit/advancedmortars.groovy renamed to examples/postInit/generated/advancedmortars_generated.groovy examples/postInit/advancedmortars.groovy renamed to examples/postInit/generated/advancedmortars_generated.groovy

@@ -2,7 +2,7 @@
 // Auto generated groovyscript example file
 // MODS_LOADED: advancedrocketry
 
-log.info 'mod \'advancedrocketry\' detected, running script'
+log 'mod \'advancedrocketry\' detected, running script'
 
 // Centrifuge:
 // Converts an input fluid into up to 12 output items and up to 4 output fluids, consuming RF.
@@ -169,5 +169,3 @@ mods.advancedrocketry.small_plate_presser.recipeBuilder()
     .input(item('minecraft:cobblestone'))
     .output(item('minecraft:diamond'))
     .register()
-
-

examples/postInit/advancedrocketry.groovy …erated/advancedrocketry_generated.groovyexamples/postInit/advancedrocketry.groovy renamed to examples/postInit/generated/advancedrocketry_generated.groovy examples/postInit/advancedrocketry.groovy renamed to examples/postInit/generated/advancedrocketry_generated.groovy

@@ -2,7 +2,7 @@
 // Auto generated groovyscript example file
 // MODS_LOADED: aether_legacy
 
-log.info 'mod \'aether_legacy\' detected, running script'
+log 'mod \'aether_legacy\' detected, running script'
 
 // Accessory:
 // The Aether Accessory system.
@@ -57,4 +57,3 @@ mods.aether_legacy.freezer_fuel.removeByItem(item('aether_legacy:icestone'))
 // mods.aether_legacy.freezer_fuel.removeAll()
 
 mods.aether_legacy.freezer_fuel.add(item('minecraft:packed_ice'), 1000)
-

examples/postInit/aether_legacy.groovy …generated/aether_legacy_generated.groovyexamples/postInit/aether_legacy.groovy renamed to examples/postInit/generated/aether_legacy_generated.groovy examples/postInit/aether_legacy.groovy renamed to examples/postInit/generated/aether_legacy_generated.groovy

@@ -2,7 +2,7 @@
 // Auto generated groovyscript example file
 // MODS_LOADED: alchemistry
 
-log.info 'mod \'alchemistry\' detected, running script'
+log 'mod \'alchemistry\' detected, running script'
 
 // Atomizer:
 // Converts a non-element into its component elements.
@@ -125,5 +125,3 @@ mods.alchemistry.liquifier.recipeBuilder()
     .input(item('minecraft:magma'))
     .fluidOutput(fluid('lava') * 750)
     .register()
-
-

examples/postInit/alchemistry.groovy …t/generated/alchemistry_generated.groovyexamples/postInit/alchemistry.groovy renamed to examples/postInit/generated/alchemistry_generated.groovy examples/postInit/alchemistry.groovy renamed to examples/postInit/generated/alchemistry_generated.groovy

@@ -4,21 +4,21 @@
 
 import appeng.capabilities.Capabilities
 
-log.info 'mod \'appliedenergistics2\' detected, running script'
+log 'mod \'appliedenergistics2\' detected, running script'
 
 // P2P Attunement:
 // Controls using specific items, any items from a mod, or any items with a Capability to convert a P2P into a specific
 // tunnel type.
 
-mods.appliedenergistics2.attunement.remove(Capabilities.FORGE_ENERGY, tunnel('fe_power'))
-mods.appliedenergistics2.attunement.remove(item('minecraft:lever'), tunnel('redstone'))
 mods.appliedenergistics2.attunement.remove('thermaldynamics', tunnel('fe_power'))
+mods.appliedenergistics2.attunement.remove(item('minecraft:lever'), tunnel('redstone'))
+mods.appliedenergistics2.attunement.remove(Capabilities.FORGE_ENERGY, tunnel('fe_power'))
 mods.appliedenergistics2.attunement.removeByTunnel(tunnel('item'))
 // mods.appliedenergistics2.attunement.removeAll()
 
-mods.appliedenergistics2.attunement.add(Capabilities.FORGE_ENERGY, tunnel('item'))
-mods.appliedenergistics2.attunement.add(item('minecraft:clay'), tunnel('item'))
 mods.appliedenergistics2.attunement.add('thermaldynamics', tunnel('redstone'))
+mods.appliedenergistics2.attunement.add(item('minecraft:clay'), tunnel('item'))
+mods.appliedenergistics2.attunement.add(Capabilities.FORGE_ENERGY, tunnel('item'))
 
 // Cannon Ammo:
 // Item and weight, where weight is a factor in how much damage is dealt.
@@ -78,4 +78,3 @@ mods.appliedenergistics2.spatial.remove('net.minecraft.tileentity.TileEntityChes
 // mods.appliedenergistics2.spatial.removeAll()
 
 mods.appliedenergistics2.spatial.add('net.minecraft.tileentity.TileEntityStructure')
-

…ples/postInit/appliedenergistics2.groovy …ted/appliedenergistics2_generated.groovyexamples/postInit/appliedenergistics2.groovy renamed to examples/postInit/generated/appliedenergistics2_generated.groovy examples/postInit/appliedenergistics2.groovy renamed to examples/postInit/generated/appliedenergistics2_generated.groovy

@@ -2,7 +2,7 @@
 // Auto generated groovyscript example file
 // MODS_LOADED: arcanearchives
 
-log.info 'mod \'arcanearchives\' detected, running script'
+log 'mod \'arcanearchives\' detected, running script'
 
 // Gem Cutting Table:
 // Converts any number of itemstacks into a single output itemstack via selecting the desired output itemstack in the GUI.
@@ -21,5 +21,3 @@ mods.arcanearchives.gem_cutting_table.recipeBuilder()
     .input(item('minecraft:stone'),item('minecraft:gold_ingot'),item('minecraft:gold_nugget'))
     .output(item('minecraft:clay') * 4)
     .register()
-
-

examples/postInit/arcanearchives.groovy …enerated/arcanearchives_generated.groovyexamples/postInit/arcanearchives.groovy renamed to examples/postInit/generated/arcanearchives_generated.groovy examples/postInit/arcanearchives.groovy renamed to examples/postInit/generated/arcanearchives_generated.groovy

@@ -2,7 +2,7 @@
 // Auto generated groovyscript example file
 // MODS_LOADED: arcaneworld
 
-log.info 'mod \'arcaneworld\' detected, running script'
+log 'mod \'arcaneworld\' detected, running script'
 
 // Ritual:
 // Converts up to 5 input itemstacks into a wide number of possible effects, including spawning entities, opening a portal
@@ -21,51 +21,40 @@ mods.arcaneworld.ritual.recipeBuilder()
     .name('groovyscript:custom_name')
     .register()
 
+mods.arcaneworld.ritual.recipeBuilderTime()
+    .input(item('minecraft:diamond'), item('minecraft:clay'), item('minecraft:clay'), item('minecraft:clay'))
+    .translationKey('groovyscript.demo_time')
+    .time(5000)
+    .register()
+
 mods.arcaneworld.ritual.recipeBuilderArena()
     .input(item('minecraft:stone'), item('minecraft:stone'), item('minecraft:clay'))
     .translationKey('groovyscript.demo_arena')
     .entity(entity('minecraft:chicken'))
     .register()
 
-mods.arcaneworld.ritual.recipeBuilderCommand()
-    .input(item('minecraft:diamond'), item('minecraft:diamond'), item('minecraft:clay'))
-    .translationKey('groovyscript.demo_command')
-    .command('say hi',
-             'give @p minecraft:coal 5')
-    .register()
-
-mods.arcaneworld.ritual.recipeBuilderCreateItem()
-    .input(item('minecraft:diamond'), item('minecraft:diamond'), item('minecraft:diamond'))
-    .translationKey('groovyscript.demo_create_item')
-    .output(item('minecraft:diamond'))
-    .register()
-
 mods.arcaneworld.ritual.recipeBuilderCustom()
     .input(item('minecraft:diamond'), item('minecraft:diamond'), item('minecraft:clay'), item('minecraft:clay'))
     .translationKey('groovyscript.demo_custom')
     .onActivate({ World world, BlockPos blockPos, EntityPlayer player, ItemStack... itemStacks -> { log.info blockPos } })
     .register()
 
-mods.arcaneworld.ritual.recipeBuilderDragonBreath()
-    .input(item('minecraft:clay'), item('minecraft:clay'), item('minecraft:clay'), item('minecraft:clay'), item('minecraft:clay'))
-    .translationKey('groovyscript.demo_dragon_breath')
-    .register()
-
-mods.arcaneworld.ritual.recipeBuilderDungeon()
-    .input(item('minecraft:diamond'), item('minecraft:clay'), item('minecraft:clay'))
-    .translationKey('groovyscript.demo_dungeon')
-    .register()
-
 mods.arcaneworld.ritual.recipeBuilderSummon()
     .input(item('minecraft:stone'), item('minecraft:clay'), item('minecraft:clay'))
     .translationKey('groovyscript.demo_summon')
     .entity(entity('minecraft:chicken'))
     .register()
 
-mods.arcaneworld.ritual.recipeBuilderTime()
-    .input(item('minecraft:diamond'), item('minecraft:clay'), item('minecraft:clay'), item('minecraft:clay'))
-    .translationKey('groovyscript.demo_time')
-    .time(5000)
+mods.arcaneworld.ritual.recipeBuilderCommand()
+    .input(item('minecraft:diamond'), item('minecraft:diamond'), item('minecraft:clay'))
+    .translationKey('groovyscript.demo_command')
+    .command('say hi',
+             'give @p minecraft:coal 5')
+    .register()
+
+mods.arcaneworld.ritual.recipeBuilderDungeon()
+    .input(item('minecraft:diamond'), item('minecraft:clay'), item('minecraft:clay'))
+    .translationKey('groovyscript.demo_dungeon')
     .register()
 
 mods.arcaneworld.ritual.recipeBuilderWeather()
@@ -86,4 +75,13 @@ mods.arcaneworld.ritual.recipeBuilderWeather()
     .weatherThunder()
     .register()
 
+mods.arcaneworld.ritual.recipeBuilderCreateItem()
+    .input(item('minecraft:diamond'), item('minecraft:diamond'), item('minecraft:diamond'))
+    .translationKey('groovyscript.demo_create_item')
+    .output(item('minecraft:diamond'))
+    .register()
 
+mods.arcaneworld.ritual.recipeBuilderDragonBreath()
+    .input(item('minecraft:clay'), item('minecraft:clay'), item('minecraft:clay'), item('minecraft:clay'), item('minecraft:clay'))
+    .translationKey('groovyscript.demo_dragon_breath')
+    .register()

examples/postInit/arcaneworld.groovy …t/generated/arcaneworld_generated.groovyexamples/postInit/arcaneworld.groovy renamed to examples/postInit/generated/arcaneworld_generated.groovy examples/postInit/arcaneworld.groovy renamed to examples/postInit/generated/arcaneworld_generated.groovy

@@ -2,7 +2,7 @@
 // Auto generated groovyscript example file
 // MODS_LOADED: armorplus
 
-log.info 'mod \'armorplus\' detected, running script'
+log 'mod \'armorplus\' detected, running script'
 
 // Champion Bench:
 // A normal crafting recipe, but with a 9x9 grid and in the Champion Bench.
@@ -41,8 +41,8 @@ mods.armorplus.high_tech_bench.removeByOutput(item('armorplus:emerald_helmet'))
 mods.armorplus.high_tech_bench.shapedBuilder()
     .output(item('minecraft:diamond') * 32)
     .matrix([[item('minecraft:gold_ingot'), item('minecraft:gold_ingot'), item('minecraft:gold_ingot')],
-            [item('minecraft:gold_ingot'), item('minecraft:gold_ingot'), item('minecraft:gold_ingot')],
-            [item('minecraft:gold_ingot'), item('minecraft:gold_ingot'), item('minecraft:gold_ingot')]])
+             [item('minecraft:gold_ingot'), item('minecraft:gold_ingot'), item('minecraft:gold_ingot')],
+             [item('minecraft:gold_ingot'), item('minecraft:gold_ingot'), item('minecraft:gold_ingot')]])
     .register()
 
 
@@ -114,5 +114,3 @@ mods.armorplus.work_bench.shapelessBuilder()
     .output(item('minecraft:clay') * 8)
     .input(item('minecraft:stone'), item('minecraft:stone'), item('minecraft:stone'))
     .register()
-
-