Undocumented constructor found JAVA-D1002
Documentation
Minor
9 months ago
—
a year old
Consider adding a doc comment for IslandLand
40
41 private final LandState landState;
42
43 public IslandLand(final Island island, final World world, double[] positions) { 44 this.island = island; 45 this.world = world; 46 this.positions = positions; 47 this.x = positions[0]; 48 this.y = positions[1]; 49 this.z = positions[2]; 50 51 final ClipboardWrapper schematicPlot = island.getSchematicClipboardWrapper(); 52 53 final RegionWrapper regionWrapper = schematicPlot.region(); 54 final VectorWrapper origin = schematicPlot.getOrigin(); 55 56 this.yaw = 0f; 57 this.pitch = 0f; 58 59 this.minPoint = regionWrapper.getMinimumPoint() 60 .subtract(origin) 61 .add(this.x, y, this.z); 62 this.maxPoint = regionWrapper.getMaximumPoint() 63 .subtract(origin) 64 .add(this.x, y, this.z); 65 66 this.location = new Location(world, this.x, y, this.z, (float) yaw, (float) pitch); 67 this.landState = new LandState(); 68 } 69
70 public void generatePlot() throws WorldEditException {
71 // TODO: Make this generation operation asyncConsider adding a doc comment for GameIsland
24
25 private IslandLand islandLand;
26
27 public GameIsland(final ArenaManager arenaManager, final Island island, 28 final GamePlayer gamePlayer) { 29 this.arenaManager = arenaManager; 30 // todo: memory leak, as this does not get invalidated once done 31 this.umbrella = new GameIslandUmbrella(this).getUmbrella(); 32 this.island = island; 33 this.gamePlayer = gamePlayer; 34 } 35
36 public void start() {
37 // setting the player's queue to trueConsider adding a doc comment for SpeedBridgeDebugCommand
23 private final Map<Island, List<GameIsland>> generatedGames = new HashMap<>();
24 private final ArenaManager arenaManager;
25
26 public SpeedBridgeDebugCommand(ArenaManager arenaManager) {27 this.arenaManager = arenaManager;28 }29
30 @Subcommand("arena teleport")
31 public String islandTeleport(final Player player) {Consider adding a doc comment for GameIsland2
7public class GameIsland2 extends GameIsland {
8 private IslandLand islandLand;
9
10 public GameIsland2(final ArenaManager arenaManager, GameIsland gameIsland) {11 super(arenaManager, gameIsland.getIsland(), gameIsland.getGamePlayer());12 }13
14 public void setIslandPlot(final IslandLand islandLand) {
15 this.islandLand = islandLand;Consider adding a doc comment for EmptyBridgePlayer
5import java.util.UUID;
6
7public class EmptyBridgePlayer extends BridgePlayer {
8 protected EmptyBridgePlayer(UUID id) { 9 super(null, null, id);10 }11}
Description
This constructor does not have any documentation.
Consider adding a documentation comment to explain its use.
While it may seem like the usage of a constructor is perfectly obvious, any consumers of your API may not be able to pick up on certain details.
Bad Practice
In the example below, it is difficult to understand what the arguments of this constructor for DataForwarder signify.
class DataForwarder {
public DataForwarder(int nTypes, String... values) {
// ...
}
}
Recommended
Document the constructor and provide useful information about it or its parameters as required.
/**
* Initializes a DataForwarder with a set of types to filter by, along with their names.
*
* @param nTypes - The number of types to filter by.
* @param values - The input type names to filter by.
*/
public DataForwarder(int nTypes, String... values) {
// ...
}
Exceptions
If you feel this constructor does not require documentation, you can add a skipcq comment to this constructor.