Clean up

Author: rijnb

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

@@ -93,7 +93,7 @@ private Common() {
      * @param maxY Longitude.
      * @return Divider.
      */
-    // TODO: Need better names for minY and maxY
+    // TODO: Need better names for minY and maxY.
     static int xDivider(final int minY, final int maxY) {
         assert minY < maxY;
         if (minY >= 0) {

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

@@ -68,7 +68,7 @@ static int getTerritoryRecordType(final int territoryRecord) {
         return (DATA_MODEL.getDataFlags(territoryRecord) >> 7) & 3; // 1=pipe 2=plus 3=star
     }
 
-    // TODO: What does "restricted" mean?
+    // TODO: Explain what "restricted" means.
     static boolean isRestricted(final int territoryRecord) {
         assert (0 <= territoryRecord) && (territoryRecord < DATA_MODEL.getNrTerritoryRecords());
         return (DATA_MODEL.getDataFlags(territoryRecord) & 512) != 0;

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

@@ -60,15 +60,14 @@ static MapcodeZone decodeToMapcodeZone(@Nonnull final String argMapcode,
         }
         assert !mapcode.contains("-");
 
-        // TODO: What does AEU unpack do?
+        // TODO: Explain what AEU unpack does.
         mapcode = aeuUnpack(mapcode).trim();
         if (mapcode.isEmpty()) {
             // TODO: Is this a useful log message?
             LOG.debug("decode: Failed to aeuUnpack {}", argMapcode);
             throw new UnknownMapcodeException("Failed to AEU unpack, mapcode=" + argMapcode + ", territory=" + argTerritory);
         }
 
-        // TODO: What does incodexlen mean?
         final int codexLen = mapcode.length() - 1;
 
         // *** long codes in states are handled by the country

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

@@ -273,6 +273,7 @@ public static Rectangle decodeToRectangle(@Nonnull final String mapcode, @Nullab
     }
 
 
+    // TODO: Explain when this method is needed/used.
     /**
      * Is coordinate near multiple territory borders?
      *
@@ -282,7 +283,6 @@ public static Rectangle decodeToRectangle(@Nonnull final String mapcode, @Nullab
      */
     public static boolean isNearMultipleBorders(@Nonnull final Point point, @Nonnull final Territory territory) {
         checkDefined("point", point);
-        // TODO: This description is not clear enough. When do you use this exactly?
         if (territory != Territory.AAA) {
             final int territoryNumber = territory.getNumber();
             if (territory.getParentTerritory() != null) {

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

@@ -24,8 +24,6 @@
  * ----------------------------------------------------------------------------------------------
  * Simple class to represent all the coordinates that would deliver a particular mapcode.
  */
-// TODO: Is a mapcode zone always a rectangle? Is the smallest rectangle around 1 mapcode, or something else?
-// TODO: Why is it called MapcodeZone and not for example MapcodeBoundary?
 class MapcodeZone {
 
     // TODO: Explain why you need these fractions and how they work exactly.
@@ -106,7 +104,7 @@ boolean isEmpty() {
         return ((lonFractionMax <= lonFractionMin) || (latFractionMax <= latFractionMin));
     }
 
-    // TODO: What does this return?
+    // TODO: Explain what this is (geo point of mapcode).
     @Nonnull
     Point getCenter() {
         if (isEmpty()) {
@@ -118,7 +116,7 @@ Point getCenter() {
         }
     }
 
-    // TODO: Explain when this is used. Does it clip a mapcode zon after it was retrieved?
+    // TODO: Explain when this is used. It clips a zone to an encompassing boundary.
     // Returns a non-empty intersection of a mapcode zone and a territory area.
     // Returns null if no such intersection exists.
     @Nonnull

src/site/markdown/ReleaseNotes.md

@@ -4,6 +4,9 @@ These are the release notes for the Java library for mapcodes.
 
 ### 2.4.4
 
+* Added calls to decode an international or territorial mapcode to its encompassing
+rectangle using `decodeToRectangle`. 
+
 * Minor code hygiene improvements.
 
 ### 2.4.3