Skip to content

Commit 3df0b60

Browse files
committed
review: Fix spelling and other documentation issues
1 parent 32d09bc commit 3df0b60

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

application/src/main/java/org/opentripplanner/graph_builder/module/transfer/filter/MinMap.java

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,10 @@
33
import java.util.Collection;
44
import java.util.HashMap;
55
import java.util.Map;
6+
import javax.annotation.Nullable;
67

78
/**
8-
* A HashMap that has been extended to track the greatest or smallest value for each key. Note that
9-
* this does not change the meaning of the 'put' method. It adds two new methods that add the
10-
* min/max behavior. This class used to be inside SimpleIsochrone.
9+
* Decorate a HashMap that to track the smallest value for each key.
1110
*/
1211
class MinMap<K, V extends Comparable<V>> {
1312

@@ -17,6 +16,7 @@ class MinMap<K, V extends Comparable<V>> {
1716
* Put the given key-value pair in the map if the map does not yet contain the key, or if the
1817
* value is less than the existing value for the same key.
1918
*
19+
* @see Map#put(Object, Object)
2020
* @return whether the key-value pair was inserted in the map.
2121
*/
2222
boolean putMin(K key, V value) {
@@ -31,6 +31,7 @@ boolean putMin(K key, V value) {
3131
/**
3232
* @see Map#get(Object)
3333
*/
34+
@Nullable
3435
public V get(K key) {
3536
return map.get(key);
3637
}

application/src/test/java/org/opentripplanner/graph_builder/module/transfer/DirectTransferGeneratorTest.java

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

1414
/**
1515
* This test uses the following graph/network for testing the DirectTransfer generation. The
16-
* fokus is on the filtering of the transfers, not on testing that the NearBySearch return the
16+
* focus is on the filtering of the transfers, not on testing that the NearBySearch return the
1717
* correct set of nearby stops.
1818
* <p>
1919
* <img src=DirectTransferGeneratorTest.drawio.png />

0 commit comments

Comments
 (0)