Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

refactor: address IntelliJ QAPlug plugin findings #5149

Merged
merged 35 commits into from
Nov 11, 2023
Merged

refactor: address IntelliJ QAPlug plugin findings #5149

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
aa6ca30
qa: make final fields static
jdrueckert Oct 22, 2023
1a53322
qa: remove unnecessary local before return
jdrueckert Oct 22, 2023
db4f626
qa: avoid instanceof checks in catch clause
jdrueckert Oct 22, 2023
e3d80fb
qa: method/constructor should not throw java.lang.Exception
jdrueckert Oct 22, 2023
f22c1fa
qa: instanceof check covers null check
jdrueckert Oct 22, 2023
9d7204b
qa: avoid toString on String objects
jdrueckert Oct 22, 2023
993b370
qa: remove overrides that only call their super
jdrueckert Oct 22, 2023
315ef35
qa: remove unused private methods
jdrueckert Oct 22, 2023
3c5d507
qa: if statement nesting not necessary
jdrueckert Oct 22, 2023
df3539a
qa: remove unused local variable
jdrueckert Oct 22, 2023
b0ec929
qa: close resources after use
jdrueckert Oct 22, 2023
06c5fcf
qa: use equals() to compare object references
jdrueckert Oct 22, 2023
3428369
Merge branch 'develop' into chore/qaplug-findings
jdrueckert Oct 27, 2023
a3f8fbc
fix: reintroduce override, needed to elevate access modifier
jdrueckert Oct 27, 2023
760a174
fix: exception type in override
jdrueckert Oct 27, 2023
f067ba2
chore: replace invalid javadoc character with unicode representation
jdrueckert Oct 27, 2023
077d488
javadoc: fix broken references
jdrueckert Oct 28, 2023
6a816ed
javadoc: fix disallowed self-closing and empty elements
jdrueckert Oct 28, 2023
a27bd8e
javadoc: fix invalid uses of @param and @return
jdrueckert Oct 28, 2023
c93ad63
javadoc: fix bad use of symbols
jdrueckert Oct 28, 2023
ad27ad0
javadoc: fix disallowed list item tag without surrounding list
jdrueckert Oct 28, 2023
cce1a8b
javadoc: fix erroneous tags
jdrueckert Oct 28, 2023
45e6571
javadoc: fix more references
jdrueckert Oct 28, 2023
35c2bc3
javadoc: fix emphasize tags
jdrueckert Oct 28, 2023
60a41a5
chore: fix missing javadoc errors
jdrueckert Oct 28, 2023
3d13e1f
javadoc: fix @see
jdrueckert Oct 29, 2023
848947e
checkstyle: remove illegal throws
jdrueckert Oct 30, 2023
f585450
checkstyle: remove unused imports
jdrueckert Oct 30, 2023
01e8edd
refactor: replace explicit close with try-with-resources
jdrueckert Oct 30, 2023
b841271
revert: removal of unused param from AbstractFamily constructor
jdrueckert Oct 30, 2023
2aad50f
revert: close zip Filesystem
jdrueckert Oct 30, 2023
49725fa
revert: removing required zip.close
jdrueckert Oct 30, 2023
bf26781
Merge branch 'develop' into chore/qaplug-findings
jdrueckert Oct 31, 2023
971c853
Merge branch 'develop' into chore/qaplug-findings
jdrueckert Nov 6, 2023
08bd7ea
Merge branch 'develop' into chore/qaplug-findings
jdrueckert Nov 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions engine/src/main/java/org/terasology/engine/entitySystem/entity/EntityPool.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,9 +133,9 @@ public interface EntityPool {
* All entities containing every one of the given components.
* <p>
* Implementation note:
* <a href="http://www.angelikalanger.com/GenericsFAQ/FAQSections/ProgrammingIdioms.html#Topic5"
* title="Designing Generic Methods">Java generic types are a mess</a>, especially where
* varargs are involved. We can't use {@link SafeVarargs @SafeVarargs} on any interface methods
* Java generic types are a mess (see <a href="http://www.angelikalanger.com/GenericsFAQ/FAQSections/ProgrammingIdioms.html#Topic5">
* Designing Generic Methods</a>), especially where varargs are involved.
* We can't use {@link SafeVarargs @SafeVarargs} on any interface methods
* because there is no way to know the <em>implementations</em> of the interface are safe.
* <p>
* In this case, in practice, there are few (if any) callers that pass more than two values.
Expand Down
2 changes: 1 addition & 1 deletion engine/src/main/java/org/terasology/engine/i18n/assets/TranslationData.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@


/**
* Defines translation data in the form of a map {ID -> value}.
* Defines translation data in the form of a map {ID → value}.
*/
public class TranslationData implements AssetData {

Expand Down
2 changes: 1 addition & 1 deletion engine/src/main/java/org/terasology/engine/logic/players/event/OnPlayerSpawnedEvent.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

/**
* This event gets sent when the player spawns.
* <br/>
* <br>
* <b>Note:</b> that this should be used only as a one time event i.e. when
* the player spawns for the first time in the game.
* On every subsequent spawn a onPlayerRespawnedEvent is sent.
Expand Down
4 changes: 2 additions & 2 deletions engine/src/main/java/org/terasology/engine/world/chunks/blockdata/ExtraBlockDataManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@
* whether the field is applicable for that block. For example:
*
* <pre>
* @ExtraDataSystem
* {@code @ExtraDataSystem}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you can put the {@code right next to the <pre> and close it only in the end.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nope, {@code ...} (same as other @... tags) unfortunately doesn't work across multiple lines.

* public class ExampleExtraDataSystem {
* @RegisterExtraData(name="exampleModule.grassNutrients", bitSize=8)
* {@code @RegisterExtraData(name="exampleModule.grassNutrients", bitSize=8)}
* public static boolean shouldHaveNutrients(Block block) {
* return block.isGrass();
* }
Expand Down
2 changes: 1 addition & 1 deletion engine/src/main/java/org/terasology/engine/world/chunks/blockdata/RegisterExtraData.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* The valid values for bitSize are 4, 8 and 16.
* The correct format is
* <pre>
* @RegisterExtraData(name="exampleModule.grassNutrients", bitSize=8)
* {@code @RegisterExtraData(name="exampleModule.grassNutrients", bitSize=8)}
* public static boolean shouldHaveNutrients(Block block) {
* return block.isGrass();
* }
Expand Down
4 changes: 2 additions & 2 deletions ...c/main/java/org/terasology/engine/world/chunks/localChunkProvider/LocalChunkProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,10 @@
* {@link OnChunkLoaded} when chunk was loaded from {@link StorageManager}
* <p>
* {@link OnActivatedBlocks} when load/generate chunk and chunk have blocks with lifecycle (?)
* {@see https://github.com/MovingBlocks/Terasology/issues/3244}
* {@see <a href="https://github.com/MovingBlocks/Terasology/issues/3244">Terasology Issue 3244</a>}
* <p>
* {@link OnAddedBlocks} when load/generate chunk and chunk have blocks with lifecycle (?)
* {@see https://github.com/MovingBlocks/Terasology/issues/3244}
* {@see <a href="https://github.com/MovingBlocks/Terasology/issues/3244">Terasology Issue 3244</a>}
* <p>
* {@link BeforeChunkUnload} when chunk ready to remove from provider.
* <p>
Expand Down
2 changes: 1 addition & 1 deletion engine/src/main/java/org/terasology/engine/world/internal/WorldProviderCore.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ public interface WorldProviderCore {

/**
* Places all given blocks of specific types at their corresponding positions
* </p>
* <p>
* Chunks are
*
* @param blocks A mapping from world position to change to the type of block to set
Expand Down
Loading