Skip to content

Commit 56c7e4b

Browse files
committed
Replace javadoc usage of <p/> since it only breaks paragraphs when using <p>
Part of me hates the dangling nature of paragraph html tags like this, but I get that this is a special case...
1 parent 158cdcb commit 56c7e4b

37 files changed

Lines changed: 54 additions & 54 deletions

recaf-core/src/main/java/software/coley/recaf/behavior/PriorityKeys.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
/**
44
* Default keys for {@link PrioritySortable} implementations.
5-
* <p/>
5+
* <p>
66
* Searching for usages of these keys will show what listeners/classes fire in which order.
77
*
88
* @author Matt Coley

recaf-core/src/main/java/software/coley/recaf/cdi/EagerInitialization.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@
1212
* Applied to beans to enable eager initialization, which is to say they and their dependencies get created as soon as
1313
* possible depending on the {@link #value() value of the intended} {@link InitializationStage}. This will result in
1414
* the bean's {@code @Inject} annotated constructor being called.
15-
* <p/>
15+
* <p>
1616
* Alternatively, you could also observe the events {@link InitializationEvent} or {@link UiInitializationEvent}
1717
* in a method with {@link Observes}. This would allow you to separate the initialization logic from the constructor
1818
* and have it reside in a separate method.
19-
* <p/>
19+
* <p>
2020
* <b>NOTE:</b> Beans are not eagerly initialized while in a test environment.
2121
*
2222
* @author Matt Coley

recaf-core/src/main/java/software/coley/recaf/info/builder/JvmClassInfoBuilder.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ public JvmClassInfoBuilder(@Nonnull byte[] bytecode, int readerFlags) {
122122
/**
123123
* Copies over values by reading the contents of the class file in the reader.
124124
* Calls {@link #adaptFrom(byte[], int)} with {@code flags=0}.
125-
* <p/>
125+
* <p>
126126
* <b>IMPORTANT:</b> If {@link #skipValidationChecks(boolean)} is {@code false} and validation checks are active
127127
* extra steps are taken to ensure the class is fully ASM compliant. You will want to wrap this call in a try-catch
128128
* block handling {@link Throwable} to cover any potential ASM failure.
@@ -148,7 +148,7 @@ public JvmClassInfoBuilder adaptFrom(@Nonnull byte[] code) {
148148
/**
149149
* Copies over values by reading the contents of the class file in the reader.
150150
* Calls {@link #adaptFrom(ClassReader, int)} with {@code flags}.
151-
* <p/>
151+
* <p>
152152
* <b>IMPORTANT:</b> If {@link #skipValidationChecks(boolean)} is {@code false} and validation checks are active
153153
* extra steps are taken to ensure the class is fully ASM compliant. You will want to wrap this call in a try-catch
154154
* block handling {@link Throwable} to cover any potential ASM failure.
@@ -176,7 +176,7 @@ public JvmClassInfoBuilder adaptFrom(@Nonnull byte[] code, int readerFlags) {
176176
/**
177177
* Copies over values by reading the contents of the class file in the reader.
178178
* Calls {@link #adaptFrom(ClassReader, int)} with {@code flags=0}.
179-
* <p/>
179+
* <p>
180180
* <b>IMPORTANT:</b> If {@link #skipValidationChecks(boolean)} is {@code false} and validation checks are active
181181
* extra steps are taken to ensure the class is fully ASM compliant. You will want to wrap this call in a try-catch
182182
* block handling {@link Throwable} to cover any potential ASM failure.
@@ -201,7 +201,7 @@ public JvmClassInfoBuilder adaptFrom(@Nonnull ClassReader reader) {
201201

202202
/**
203203
* Copies over values by reading the contents of the class file in the reader.
204-
* <p/>
204+
* <p>
205205
* <b>IMPORTANT:</b> If {@link #skipValidationChecks(boolean)} is {@code false} and validation checks are active
206206
* extra steps are taken to ensure the class is fully ASM compliant. You will want to wrap this call in a try-catch
207207
* block handling {@link Throwable} to cover any potential ASM failure.

recaf-core/src/main/java/software/coley/recaf/path/PathNode.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
* A <i>"modular"</i> value type for representing <i>"paths"</i> to content in a {@link Workspace}.
1414
* The path must contain all data in a <i>"chain"</i> such that it can have access from most specific portion
1515
* all the way up to the {@link Workspace} portion.
16-
* <p/>
16+
* <p>
1717
* <b>NOTE: Regarding contents in embedded resources,</b> the path result of the methods like
1818
* {@link Workspace#findClass(String)} will contain the root {@link WorkspaceResource} but the exact {@link Bundle}.
1919
* To find the exact embedded resource of a result use {@link WorkspaceResource#resolveBundleContainer(Bundle)}.
@@ -44,7 +44,7 @@ public interface PathNode<V> extends Comparable<PathNode<?>> {
4444
/**
4545
* Creates a copy of the path node with this child-most node's value being looked up for a newer
4646
* value in the associated workspace.
47-
* <p/>
47+
* <p>
4848
* <b>Note:</b> A {@link WorkspacePathNode} must be present.
4949
*
5050
* @return A new path node pointing to the same location,

recaf-core/src/main/java/software/coley/recaf/path/PathNodes.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@
1919

2020
/**
2121
* Utility methods for constructing paths.
22-
* <p/>
22+
* <p>
2323
* Generally you should use this only when the path creation is
2424
* a <i>"one time"</i> action. For instance, if you want to make a path to a single method, use
2525
* {@link #memberPath(Workspace, WorkspaceResource, Bundle, ClassInfo, ClassMember)}.
26-
* <p/>
26+
* <p>
2727
* However, if you want to make a path to <i>all methods in a class</i> then you would use
2828
* {@link #classPath(Workspace, WorkspaceResource, Bundle, ClassInfo)} to get a {@link ClassPathNode}
2929
* and then use {@link ClassPathNode#child(ClassMember)} for each member. This reduces the number of redundant
@@ -352,7 +352,7 @@ public static PathNode<?> unique(@Nonnull String identifier) {
352352

353353
/**
354354
* A path node that just holds an arbitrary string.
355-
* <p/>
355+
* <p>
356356
* Intended for use in the UI where displayed panels are intended to be navigable for tracking, not actually
357357
* navigable in terms of their relationship to some location in a workspace.
358358
*

recaf-core/src/main/java/software/coley/recaf/services/assembler/WorkspaceFieldValueLookup.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
/**
1515
* Field value lookup for items in a {@link Workspace}.
16-
* <p/>
16+
* <p>
1717
* Its very basic, only looking at static fields default values.
1818
*
1919
* @author Matt Coley

recaf-core/src/main/java/software/coley/recaf/services/deobfuscation/transform/generic/KotlinMetadataCollectionTransformer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141

4242
/**
4343
* A transformer that collects kotlin metadata and offers utilities to process it.
44-
* <p/>
44+
* <p>
4545
* For deobfuscating descriptors it is recommended to use the following methods in order:
4646
* <ol>
4747
* <li>{@link #mapKtDescriptor(KtType)} / {@link #mapKtDescriptor(KtFunction)}</li>

recaf-core/src/main/java/software/coley/recaf/services/deobfuscation/transform/generic/VariableFoldingTransformer.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ public void transform(@Nonnull JvmTransformerContext context, @Nonnull Workspace
198198

199199
/**
200200
* Populate variable liveness for the method.
201-
* <p/>
201+
* <p>
202202
* Liveness is the set of variables that are live at each instruction.
203203
* A good reference for this can be found <a href="https://users.cs.northwestern.edu/%7Esimonec/files/Teaching/CAT/slides/DFA_part1.pdf">here</a>.
204204
*
@@ -283,7 +283,7 @@ private static void populateLiveness(@Nonnull MethodNode method,
283283

284284
/**
285285
* Populate variable access states for the method.
286-
* <p/>
286+
* <p>
287287
* This tracks when variables are read from and written to, which is necessary
288288
* for determining when variable copies are redundant and can be folded.
289289
*

recaf-core/src/main/java/software/coley/recaf/services/mapping/Mappings.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ public interface Mappings {
2525
* Some mapping formats do not include field types since name overloading is illegal at the source level of Java.
2626
* It's valid in the bytecode but the mapping omits this info since it isn't necessary information for mapping
2727
* that does not support name overloading.
28-
* <p/>
28+
* <p>
2929
* This is mostly only relevant for usage of {@link MappingsAdapter} which
3030
*
3131
* @return {@code true} when field mappings include the type descriptor in their lookup information.

recaf-core/src/main/java/software/coley/recaf/services/mapping/UniqueKeyMappings.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@
1010
/**
1111
* A simple {@link Mappings} implementation that assumes all classes, fields, and methods are uniquely identified.
1212
* Mapping outputs are keyed to these unique identifiers, rather than a full {@code name + desc} pair.
13-
* <p/>
13+
* <p>
1414
* This mappings implementation can be useful to pass to {@link MappingApplier} for some scenarios like
1515
* Minecraft mappings, where each class, field, and method are uniquely identified. Minecraft's Forge, Fabric-Yarn and
1616
* Mod-Coder-Pack all have <i>"intermediate"</i> names that follow this pattern.
17-
* <p/>
17+
* <p>
1818
* Example use case:
1919
* <pre>{@code
2020
* MappingApplier applier = ...;

0 commit comments

Comments
 (0)