Skip to content

Commit 0602ab4

Browse files
committed
Fix Javadoc punctuation in optics and format classes
1 parent 3ecafce commit 0602ab4

7 files changed

Lines changed: 14 additions & 14 deletions

File tree

aether-datafixers-api/src/main/java/de/splatgames/aether/datafixers/api/optic/Affine.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
*
3535
* <p>An {@code Affine} is the generalization of both {@link Lens} and {@link Prism}. Like a lens,
3636
* it can set values within a structure. Like a prism, the focus may not exist. This makes affines ideal for optional
37-
* fields within product typesfields that might be present but aren't guaranteed.</p>
37+
* fields within product types-fields that might be present but aren't guaranteed.</p>
3838
*
3939
* <h2>When to Use an Affine</h2>
4040
* <p>Use an affine when you need to:</p>

aether-datafixers-api/src/main/java/de/splatgames/aether/datafixers/api/optic/Finder.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -197,11 +197,11 @@ public Dynamic<?> set(@NotNull final Dynamic<?> root,
197197
* Dynamic<?> updated = firstScoreFinder.set(data, data.createInt(100));
198198
* // updated: {"scores": [100, 92, 78]}
199199
*
200-
* // Out-of-range (positive) index get returns null, set returns root unchanged
200+
* // Out-of-range (positive) index - get returns null, set returns root unchanged
201201
* Finder<?> outOfBounds = scoresFinder.then(Finder.index(10));
202202
* Dynamic<?> missing = outOfBounds.get(data); // null
203203
*
204-
* // Negative index throws IllegalArgumentException immediately
204+
* // Negative index - throws IllegalArgumentException immediately
205205
* Finder.index(-1); // throws IllegalArgumentException
206206
* }</pre>
207207
*
@@ -259,7 +259,7 @@ public String id() {
259259
/**
260260
* Creates an identity finder that focuses on the root dynamic value itself.
261261
*
262-
* <p>The identity finder is the simplest possible finderit returns the entire
262+
* <p>The identity finder is the simplest possible finder-it returns the entire
263263
* root as its focus and replaces the entire root when set. This is useful as a starting point for composition or as
264264
* a neutral element in finder chains.</p>
265265
*

aether-datafixers-api/src/main/java/de/splatgames/aether/datafixers/api/optic/Getter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
* A getter is a read-only optic that extracts a value from a source without modification capability.
3232
*
3333
* <p>A {@code Getter} represents the most basic form of optic: a simple function from a
34-
* source type to a focus type. Unlike a {@link Lens}, a getter provides no way to modify the sourceit is purely for
34+
* source type to a focus type. Unlike a {@link Lens}, a getter provides no way to modify the source-it is purely for
3535
* extraction. This makes getters ideal when you want to explicitly communicate that a transformation is one-way and
3636
* read-only.</p>
3737
*

aether-datafixers-api/src/main/java/de/splatgames/aether/datafixers/api/optic/Iso.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
*
3434
* <p>An {@code Iso} (isomorphism) is the most powerful optic, representing a 1-to-1
3535
* correspondence between two types. It can convert from S to A and back to S without any loss of information. Because
36-
* of this bidirectional nature, an iso is simultaneously both a {@link Lens} and a {@link Prism}it can be used
36+
* of this bidirectional nature, an iso is simultaneously both a {@link Lens} and a {@link Prism}-it can be used
3737
* anywhere either is expected.</p>
3838
*
3939
* <h2>When to Use an Iso</h2>

aether-datafixers-api/src/main/java/de/splatgames/aether/datafixers/api/type/template/TypeFamily.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ static TypeFamily of(@NotNull final IntFunction<Type<?>> function) {
179179
* structures.</p>
180180
*
181181
* <p><strong>Important:</strong> The self-reference family must not be accessed
182-
* during the definition function's initial callit's only valid after the definition returns. Accessing index 0
182+
* during the definition function's initial call-it's only valid after the definition returns. Accessing index 0
183183
* before initialization throws an exception.</p>
184184
*
185185
* <h4>Example</h4>

aether-datafixers-api/src/main/java/de/splatgames/aether/datafixers/api/type/template/TypeTemplate.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ default String describe() {
162162
* {@code "name=originalDescription"}. This is primarily useful for debugging and logging, making it easier to
163163
* identify templates in error messages.</p>
164164
*
165-
* <p>The template's behavior is unchangedonly its {@link #describe()} output
165+
* <p>The template's behavior is unchanged-only its {@link #describe()} output
166166
* is affected.</p>
167167
*
168168
* <h4>Example</h4>

aether-datafixers-cli/src/main/java/de/splatgames/aether/datafixers/cli/format/FormatHandler.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,12 @@
3333
*
3434
* <h2>Built-in Format Handlers</h2>
3535
* <ul>
36-
* <li>{@code json-gson} JSON format using Google Gson</li>
37-
* <li>{@code json-jackson} JSON format using Jackson Databind</li>
38-
* <li>{@code yaml-snakeyaml} YAML format using SnakeYAML</li>
39-
* <li>{@code yaml-jackson} YAML format using Jackson YAML</li>
40-
* <li>{@code toml-jackson} TOML format using Jackson TOML</li>
41-
* <li>{@code xml-jackson} XML format using Jackson XML</li>
36+
* <li>{@code json-gson} - JSON format using Google Gson</li>
37+
* <li>{@code json-jackson} - JSON format using Jackson Databind</li>
38+
* <li>{@code yaml-snakeyaml} - YAML format using SnakeYAML</li>
39+
* <li>{@code yaml-jackson} - YAML format using Jackson YAML</li>
40+
* <li>{@code toml-jackson} - TOML format using Jackson TOML</li>
41+
* <li>{@code xml-jackson} - XML format using Jackson XML</li>
4242
* </ul>
4343
*
4444
* <h2>Implementing a Custom Format Handler</h2>

0 commit comments

Comments
 (0)