diff --git a/examples/postInit/roots.groovy b/examples/postInit/roots.groovy index 82e829b1f..5236f3a0a 100644 --- a/examples/postInit/roots.groovy +++ b/examples/postInit/roots.groovy @@ -208,8 +208,8 @@ mods.roots.pacifist.recipeBuilder() // Predicates: -// Predicates are used in Transmution and RunicShearBlock. They either match all blockstates of a block, or all blockstates -// that have the given properties that match the input blockstate. +// Predicates are used in Transmutation and RunicShearBlock. They either match all blockstates of a block, or all +// blockstates that have the given properties that match the input blockstate. mods.roots.predicates.stateBuilder() .blockstate(blockstate('minecraft:red_flower')) diff --git a/src/main/java/com/cleanroommc/groovyscript/api/documentation/annotations/Admonition.java b/src/main/java/com/cleanroommc/groovyscript/api/documentation/annotations/Admonition.java index 52cf9b91d..a735ed589 100644 --- a/src/main/java/com/cleanroommc/groovyscript/api/documentation/annotations/Admonition.java +++ b/src/main/java/com/cleanroommc/groovyscript/api/documentation/annotations/Admonition.java @@ -18,7 +18,7 @@ * The localization key for the admonition description, should be in the format of *
* - * groovyscript.wiki.{@link com.cleanroommc.groovyscript.registry.VirtualizedRegistry#getName() VirtualizedRegistry#getName()}.note{index of note in array} + * groovyscript.wiki.{@link com.cleanroommc.groovyscript.registry.VirtualizedRegistry#getName() {name}}.note{index} * * * @return localization key for the admonition description diff --git a/src/main/java/com/cleanroommc/groovyscript/api/documentation/annotations/Example.java b/src/main/java/com/cleanroommc/groovyscript/api/documentation/annotations/Example.java index 04c47382a..bb9c3b9c9 100644 --- a/src/main/java/com/cleanroommc/groovyscript/api/documentation/annotations/Example.java +++ b/src/main/java/com/cleanroommc/groovyscript/api/documentation/annotations/Example.java @@ -27,10 +27,15 @@ public @interface Example { /** - * For recipe builders, this will be a string that is a valid one-line series of methods to create a Recipe Builder that will + * For basic recipe builders, this will be a string that is a valid one-line series of methods to create a Recipe Builder that will * pass the {@link com.cleanroommc.groovyscript.helper.recipe.IRecipeBuilder#validate() IRecipeBuilder#validate()} check and be successfully registered. - *
- * For methods, this should be exclusive the parameters of the method. e.g. {@code "item('minecraft:clay')"}
+ * {@code ".do('thing').and('other')"} + *

+ * For complex recipe builders, those that have one or more parameters, in the creation method, + * the above is true after an initial segment for the creation. {@code "('init').do('thing').and('other')"} + *

+ * For methods, this should be exclusive the parameters of the method. e.g. {@code "item('minecraft:clay')"} + *

* Any comments for the wiki should be marked by * * /*()*{@literal /} diff --git a/src/main/java/com/cleanroommc/groovyscript/api/documentation/annotations/MethodDescription.java b/src/main/java/com/cleanroommc/groovyscript/api/documentation/annotations/MethodDescription.java index 35b1688fc..598d2f136 100644 --- a/src/main/java/com/cleanroommc/groovyscript/api/documentation/annotations/MethodDescription.java +++ b/src/main/java/com/cleanroommc/groovyscript/api/documentation/annotations/MethodDescription.java @@ -11,9 +11,15 @@ * All fields are optional, and most have default values generated in {@link Example}. * *

*

@@ -24,7 +24,7 @@ *