Skip to content

Commit 7656634

Browse files
committed
Improve Javadoc formatting by replacing <h3> elements with styled <p> tags for consistency.
1 parent 7412cad commit 7656634

3 files changed

Lines changed: 10 additions & 10 deletions

File tree

aether-datafixers-api/src/main/java/de/splatgames/aether/datafixers/api/bootstrap/DataFixerBootstrap.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ public interface DataFixerBootstrap {
9191
* registry with {@link Schema} instances for each supported data version. Schemas define the structure and types
9292
* available at each version of the data model.</p>
9393
*
94-
* <h3>Implementation Guidelines</h3>
94+
* <p><b>Implementation Guidelines</b></p>
9595
* <p>When implementing this method, consider the following best practices:</p>
9696
* <ul>
9797
* <li><b>Version Ordering:</b> Register schemas in ascending version order for clarity,
@@ -104,7 +104,7 @@ public interface DataFixerBootstrap {
104104
* definitions between versions when types remain unchanged</li>
105105
* </ul>
106106
*
107-
* <h3>Example Implementation</h3>
107+
* <p><b>Example Implementation</b></p>
108108
* <pre>{@code
109109
* @Override
110110
* public void registerSchemas(SchemaRegistry schemas) {
@@ -122,7 +122,7 @@ public interface DataFixerBootstrap {
122122
* }
123123
* }</pre>
124124
*
125-
* <h3>Thread Safety</h3>
125+
* <p><b>Thread Safety</b></p>
126126
* <p>This method is typically called once during initialization on a single thread.
127127
* Implementations do not need to be thread-safe, but they should not retain references
128128
* to the registry after the method returns.</p>
@@ -141,7 +141,7 @@ public interface DataFixerBootstrap {
141141
* {@link DataFix} instances that handle migrations between data versions. Each fix defines a transformation from
142142
* one version to another for a specific type or set of types.</p>
143143
*
144-
* <h3>Implementation Guidelines</h3>
144+
* <p><b>Implementation Guidelines</b></p>
145145
* <p>When implementing this method, adhere to these best practices:</p>
146146
* <ul>
147147
* <li><b>Version Coverage:</b> Ensure there are fixes to migrate between all
@@ -154,7 +154,7 @@ public interface DataFixerBootstrap {
154154
* the order in which they are registered</li>
155155
* </ul>
156156
*
157-
* <h3>Example Implementation</h3>
157+
* <p><b>Example Implementation</b></p>
158158
* <pre>{@code
159159
* @Override
160160
* public void registerFixes(FixRegistrar fixes) {
@@ -172,7 +172,7 @@ public interface DataFixerBootstrap {
172172
* }
173173
* }</pre>
174174
*
175-
* <h3>Thread Safety</h3>
175+
* <p><b>Thread Safety</b></p>
176176
* <p>This method is typically called once during initialization on a single thread.
177177
* Implementations do not need to be thread-safe, but they should not retain references
178178
* to the registrar after the method returns.</p>

aether-datafixers-api/src/main/java/de/splatgames/aether/datafixers/api/diagnostic/MigrationReport.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ default String toSummary() {
251251
* migration events as they occur. After the migration completes, {@link #build()} produces an immutable
252252
* report.</p>
253253
*
254-
* <h3>Lifecycle</h3>
254+
* <p><b>Lifecycle</b></p>
255255
* <p>The builder follows a specific lifecycle that must be adhered to:</p>
256256
* <ol>
257257
* <li>Call {@link #startMigration(TypeReference, DataVersion, DataVersion)} exactly once</li>
@@ -261,7 +261,7 @@ default String toSummary() {
261261
* <li>Call {@link #build()} exactly once to produce the report</li>
262262
* </ol>
263263
*
264-
* <h3>Usage Pattern</h3>
264+
* <p><b>Usage Pattern</b></p>
265265
* <pre>{@code
266266
* // Called by DataFixerImpl during migration
267267
* builder.startMigration(type, fromVersion, toVersion);
@@ -277,7 +277,7 @@ default String toSummary() {
277277
* MigrationReport report = builder.build();
278278
* }</pre>
279279
*
280-
* <h3>Thread Safety</h3>
280+
* <p><b>Thread Safety</b></p>
281281
* <p>This builder is not thread-safe. It should be used by a single thread
282282
* during the course of a migration operation. The resulting {@link MigrationReport}
283283
* is immutable and thread-safe.</p>

aether-datafixers-api/src/main/java/de/splatgames/aether/datafixers/api/dynamic/Dynamic.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ public boolean isBoolean() {
227227
*
228228
* <p>If this value is not a string, the returned {@link DataResult} will contain an error
229229
* message explaining the type mismatch. Use {@link DataResult#result()} to safely extract the value as an
230-
* {@link Optional}, or {@link DataResult#getOrThrow()} to throw on failure.</p>
230+
* {@link Optional}, or {@code getOrThrow()} to throw on failure.</p>
231231
*
232232
* <h4>Example</h4>
233233
* <pre>{@code

0 commit comments

Comments
 (0)