Skip to content

Commit

Permalink
Fix JavaDocs
Browse files Browse the repository at this point in the history
Signed-off-by: Taylor Smock <[email protected]>
  • Loading branch information
tsmock committed Dec 14, 2022
1 parent 9507670 commit f633e40
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -68,14 +68,16 @@
public class GetDataRunnable extends RecursiveTask<DataSet> {
/**
* This is functionally equivalent to
* {@link org.openstreetmap.josm.data.validation.tests.DuplicateNode#NodeHash}
* {@link org.openstreetmap.josm.data.validation.tests.DuplicateNode.NodeHash}
*/
private static class ILatLonHash implements Hash<Object, Object> {
private static final double PRECISION = DEGREE_BUFFER;

/**
* Returns the rounded coordinated according to {@link #PRECISION}
*
* @param coor The coordinate to round
* @return The rounded coordinate
* @see LatLon#roundToOsmPrecision
*/
private static ILatLon roundCoord(ILatLon coor) {
Expand Down Expand Up @@ -484,8 +486,8 @@ public static void removeCommonTags(DataSet dataSet) {
}

/**
* Create an efficient collection ({@link Storage}) of {@link List<Node>} and
* {@link Node} objects
* Create an efficient collection ({@link Storage}) of {@link List} of
* {@link Node}s and {@link Node} objects
*
* @param dataSet The dataset to get nodes from
* @return The storage to use
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -659,7 +659,7 @@ public void setAlreadyConflatedKey(String key) {
* Get the key that indicates an object is already conflated, and if so, to what
* Please note that it may be `true`/`false` instead of an object id.
*
* return The key returned by the server indicating the conflation object
* @return The key returned by the server indicating the conflation object
*/
public String getAlreadyConflatedKey() {
return alreadyConflatedKey;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -201,8 +201,9 @@ private ForkJoinTask<MapWithAIInfo> parse(JsonObject feature) {
/**
* Get the json string for a URL
*
* @param url The URL to get
* @param fastFail Fail fast (1 second)
* @param url The URL to get
* @param fastFail Fail fast (1 second)
* @param defaultMaxAge the default max age for the response to be cached
* @return The json string, or {@code null}.
*/
@Nullable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -405,10 +405,10 @@ public static Collection<AccessTags> getByTransportType(AccessTags type) {
}

/**
* The key for children modes for the map, see {@link Access#getAccessMethods}
* The key for children modes for the map, see {@link Access#accessMethods}
*/
public static final String CHILDREN = "children";
/** The key for parent modes for the map, see {@link Access#getAccessMethods} */
/** The key for parent modes for the map, see {@link Access#accessMethods} */
public static final String PARENT = "parent";
/** This set has keys that indicate that access is possible */
private static final Set<String> POSITIVE_ACCESS = new HashSet<>(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,8 @@ public enum SafeColors {

/**
* Get the safe color
*
* @return The safe color
*/
public Color getColor() {
return new Color(this.color.getRGB());
Expand Down

0 comments on commit f633e40

Please sign in to comment.