Skip to content

Commit 596d6cb

Browse files
rijnbrijnb
committed
Fixes JavaDoc comments
1 parent 2c35447 commit 596d6cb

File tree

11 files changed

+67
-71
lines changed

11 files changed

+67
-71
lines changed

‎src/main/java/com/mapcode/Boundary.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@
1818

1919
import javax.annotation.Nonnull;
2020

21+
// ----------------------------------------------------------------------------------------------
22+
// Package private implementation class. For internal use within the mapcode implementation only.
23+
//----------------------------------------------------------------------------------------------
24+
2125
/**
22-
* ----------------------------------------------------------------------------------------------
23-
* Package private implementation class. For internal use within the mapcode implementation only.
24-
* ----------------------------------------------------------------------------------------------
25-
*
2626
* This class handles territory rectangles for mapcodes.
2727
*/
2828
final class Boundary {

‎src/main/java/com/mapcode/CheckArgs.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@
2121

2222
import static com.mapcode.Mapcode.getPrecisionFormat;
2323

24+
// ----------------------------------------------------------------------------------------------
25+
// Package private implementation class. For internal use within the mapcode implementation only.
26+
// ----------------------------------------------------------------------------------------------
27+
2428
/**
25-
* ----------------------------------------------------------------------------------------------
26-
* Package private implementation class. For internal use within the mapcode implementation only.
27-
* ----------------------------------------------------------------------------------------------
28-
*
2929
* This class provides a number of helper methods to check (runtime) arguments.
3030
*/
3131
final class CheckArgs {

‎src/main/java/com/mapcode/Common.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@
1919
import org.slf4j.Logger;
2020
import org.slf4j.LoggerFactory;
2121

22+
// ----------------------------------------------------------------------------------------------
23+
// Package private implementation class. For internal use within the Mapcode implementation only.
24+
// ----------------------------------------------------------------------------------------------
25+
2226
/**
23-
* ----------------------------------------------------------------------------------------------
24-
* Package private implementation class. For internal use within the Mapcode implementation only.
25-
* ----------------------------------------------------------------------------------------------
26-
*
2727
* This class contains common data structures and methods used by the Mapcode implementation.
2828
*/
2929
@SuppressWarnings("MagicNumber")

‎src/main/java/com/mapcode/Data.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@
1818

1919
import javax.annotation.Nonnull;
2020

21+
// ----------------------------------------------------------------------------------------------
22+
// Package private implementation class. For internal use within the Mapcode implementation only.
23+
// ----------------------------------------------------------------------------------------------
24+
2125
/**
22-
* ----------------------------------------------------------------------------------------------
23-
* Package private implementation class. For internal use within the Mapcode implementation only.
24-
* ----------------------------------------------------------------------------------------------
25-
*
2626
* This class the data class for Mapcode codex items.
2727
*/
2828
@SuppressWarnings("MagicNumber")

‎src/main/java/com/mapcode/DataModel.java‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@
2424
import java.io.IOException;
2525
import java.io.InputStream;
2626

27+
// ----------------------------------------------------------------------------------------------
28+
// Package private implementation class. For internal use within the Mapcode implementation only.
29+
// ----------------------------------------------------------------------------------------------
30+
2731
/**
28-
* ----------------------------------------------------------------------------------------------
29-
* Package private implementation class. For internal use within the Mapcode implementation only.
30-
* ----------------------------------------------------------------------------------------------
31-
*
3232
* This class contains the module that reads the Mapcode areas into memory and processes them.
3333
*/
3434
@SuppressWarnings("MagicNumber")
@@ -204,7 +204,7 @@ int getNrTerritoryRecords() {
204204
}
205205

206206
@SuppressWarnings("PointlessArithmeticExpression")
207-
// TODO: Explain what this does exactly, why not return a Point or Rectangle?
207+
// TODO: Explain what this does exactly, why not return a Point or Rectangle?
208208
int getLonMicroDegMin(final int territoryRecord) {
209209
return data[((territoryRecord * DATA_FIELDS_PER_REC) + POS_DATA_LON_MICRO_DEG_MIN)];
210210
}

‎src/main/java/com/mapcode/Decoder.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@
2323

2424
import static com.mapcode.Boundary.createBoundaryForTerritoryRecord;
2525

26+
// ----------------------------------------------------------------------------------------------
27+
// Package private implementation class. For internal use within the mapcode implementation only.
28+
//----------------------------------------------------------------------------------------------
29+
2630
/**
27-
* ----------------------------------------------------------------------------------------------
28-
* Package private implementation class. For internal use within the Mapcode implementation only.
29-
* ----------------------------------------------------------------------------------------------
30-
*
3131
* This class contains decoder for mapcodes.
3232
*/
3333
@SuppressWarnings({"MagicNumber", "StringConcatenationMissingWhitespace"})

‎src/main/java/com/mapcode/Encoder.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@
2727
import static com.mapcode.Boundary.createBoundaryForTerritoryRecord;
2828
import static com.mapcode.Common.*;
2929

30+
// ----------------------------------------------------------------------------------------------
31+
// Package private implementation class. For internal use within the Mapcode implementation only.
32+
// ----------------------------------------------------------------------------------------------
33+
3034
/**
31-
* ----------------------------------------------------------------------------------------------
32-
* Package private implementation class. For internal use within the Mapcode implementation only.
33-
* ----------------------------------------------------------------------------------------------
34-
*
3535
* This class contains encoder for mapcodes.
3636
*/
3737
@SuppressWarnings({"MagicNumber", "StringConcatenationMissingWhitespace"})

‎src/main/java/com/mapcode/MapcodeCodec.java‎

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@
2626
import static com.mapcode.CheckArgs.checkNonnull;
2727
import static com.mapcode.Mapcode.getPrecisionFormat;
2828

29+
// ----------------------------------------------------------------------------------------------
30+
// Package private implementation class. For internal use within the mapcode implementation only.
31+
//----------------------------------------------------------------------------------------------
32+
2933
/**
30-
* ----------------------------------------------------------------------------------------------
31-
* Mapcode public interface.
32-
* ----------------------------------------------------------------------------------------------
33-
*
3434
* This class is the external Java interface for encoding and decoding mapcodes.
3535
*/
3636
@SuppressWarnings("MagicNumber")
@@ -43,11 +43,9 @@ private MapcodeCodec() {
4343
// Prevent instantiation.
4444
}
4545

46-
/**
47-
* ------------------------------------------------------------------------------------------
48-
* Encoding latitude, longitude to mapcodes.
49-
* ------------------------------------------------------------------------------------------
50-
*/
46+
// ------------------------------------------------------------------------------------------
47+
// Encoding latitude, longitude to mapcodes.
48+
// ------------------------------------------------------------------------------------------
5149

5250
/**
5351
* Encode a lat/lon pair to a mapcode with territory information. This produces a non-empty list of mapcode,
@@ -243,11 +241,10 @@ public static Mapcode encodeToInternational(@Nonnull final Point point)
243241
return encodeToInternational(point.getLatDeg(), point.getLonDeg());
244242
}
245243

246-
/**
247-
* ------------------------------------------------------------------------------------------
248-
* Decoding mapcodes back to latitude, longitude.
249-
* ------------------------------------------------------------------------------------------
250-
*/
244+
// ------------------------------------------------------------------------------------------
245+
// Decoding mapcodes back to latitude, longitude.
246+
// ------------------------------------------------------------------------------------------
247+
//
251248

252249
/**
253250
* Decode a mapcode to a Point. The decoding process may fail for local mapcodes,

‎src/main/java/com/mapcode/MapcodeZone.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@
1818

1919
import javax.annotation.Nonnull;
2020

21+
// ----------------------------------------------------------------------------------------------
22+
// Package private implementation class. For internal use within the Mapcode implementation only.
23+
// ----------------------------------------------------------------------------------------------
24+
2125
/**
22-
* ----------------------------------------------------------------------------------------------
23-
* Package private implementation class. For internal use within the Mapcode implementation only.
24-
* ----------------------------------------------------------------------------------------------
25-
*
2626
* Simple class to represent all the coordinates that would deliver a particular mapcode.
2727
*/
2828
class MapcodeZone {

‎src/main/java/com/mapcode/Point.java‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -241,11 +241,10 @@ public boolean equals(final Object obj) {
241241
(this.defined == that.defined);
242242
}
243243

244-
/**
245-
* -----------------------------------------------------------------------
246-
* (Package) private data and methods.
247-
* -----------------------------------------------------------------------
248-
*/
244+
// -----------------------------------------------------------------------
245+
// (Package) private data and methods.
246+
// -----------------------------------------------------------------------
247+
249248
// Constants to convert between Degrees, MicroDegrees and Fractions
250249
static final double MICRODEG_TO_DEG_FACTOR = 1000000.0;
251250
static final double MAX_PRECISION_FACTOR = 810000.0;

0 commit comments

Comments
 (0)