Index: trunk/src/org/openstreetmap/josm/actions/AlignInLineAction.java =================================================================== --- trunk/src/org/openstreetmap/josm/actions/AlignInLineAction.java (revision 8456) +++ trunk/src/org/openstreetmap/josm/actions/AlignInLineAction.java (revision 8459) @@ -38,8 +38,6 @@ * Case 4.1: Only nodes selected, part of a non-closed way: align these nodes on the line passing through the * extremity nodes (most distant in the way sequence). See https://josm.openstreetmap.de/ticket/9605#comment:3 - * Case 4.2: Only nodes selected, part of a closed way: align these nodes on the line passing through the most distant - * nodes. - * Case 4.3: Only nodes selected, part of multiple ways: align these nodes on the line passing through the most distant - * nodes. + * Case 4.2: Only nodes selected, part of a closed way: align these nodes on the line passing through the most distant nodes. + * Case 4.3: Only nodes selected, part of multiple ways: align these nodes on the line passing through the most distant nodes. * * @@ -85,7 +83,4 @@ */ private Node[] nodePairFurthestApart(List nodes) { - Node nodea = null; - Node nodeb = null; - // Detect if selected nodes are on the same way. @@ -111,4 +106,7 @@ return nodeFurthestAppart(nodes); } + + Node nodea = null; + Node nodeb = null; // The way is open, align nodes on the line passing through the extremity nodes (most distant in the way @@ -231,5 +229,5 @@ * @param ways Collection of way to align * @return Command that perform action - * @throws InvalidSelection + * @throws InvalidSelection if a polygon is selected, or if a node is used by 3 or more ways */ private Command alignMultiWay(Collection ways) throws InvalidSelection { @@ -268,5 +266,5 @@ * @param refWays Ways where useful lines will be searched * @return List of useful lines - * @throws InvalidSelection + * @throws InvalidSelection if a node got more than 4 neighbours (self-crossing way) */ private List getInvolvedLines(Node node, List refWays) throws InvalidSelection { @@ -314,5 +312,5 @@ } } else - throw new InvalidSelection(); + throw new InvalidSelection("cannot treat more than 4 neighbours, got "+neighbors.size()); } return lines; @@ -324,5 +322,5 @@ * @param lines Lines to align node on * @return Command that perform action - * @throws InvalidSelection + * @throws InvalidSelection if more than 2 lines */ private Command alignSingleNode(Node node, List lines) throws InvalidSelection { @@ -351,7 +349,7 @@ /** * Init a line by 2 nodes. - * @param first On point of the line + * @param first One point of the line * @param last Other point of the line - * @throws InvalidSelection + * @throws InvalidSelection if nodes have same coordinates */ public Line(Node first, Node last) throws InvalidSelection { @@ -364,6 +362,5 @@ double norm = Math.sqrt(a*a + b*b); if (norm == 0) - // Nodes have same coordinates ! - throw new InvalidSelection(); + throw new InvalidSelection("Nodes have same coordinates!"); a /= norm; b /= norm; @@ -374,5 +371,5 @@ * Init a line equation from a way. * @param way Use extremity of this way to compute line equation - * @throws InvalidSelection + * @throws InvalidSelection if nodes have same coordinates */ public Line(Way way) throws InvalidSelection { @@ -395,5 +392,5 @@ * @param other Second line for intersection * @return The command that move the node - * @throws InvalidSelection + * @throws InvalidSelection if two parallels ways found */ public Command intersectionCommand(Node n, Line other) throws InvalidSelection { Index: trunk/src/org/openstreetmap/josm/actions/CombineWayAction.java =================================================================== --- trunk/src/org/openstreetmap/josm/actions/CombineWayAction.java (revision 8456) +++ trunk/src/org/openstreetmap/josm/actions/CombineWayAction.java (revision 8459) @@ -96,7 +96,6 @@ * Combine multiple ways into one. * @param ways the way to combine to one way - * @return null if ways cannot be combined. Otherwise returns the combined - * ways and the commands to combine - * @throws UserCancelException + * @return null if ways cannot be combined. Otherwise returns the combined ways and the commands to combine + * @throws UserCancelException if the user cancelled a dialog. */ public static Pair combineWaysWorker(Collection ways) throws UserCancelException { @@ -111,6 +110,5 @@ ways = new LinkedHashSet<>(ways); - // try to build a new way which includes all the combined - // ways + // try to build a new way which includes all the combined ways // NodeGraph graph = NodeGraph.createNearlyUndirectedGraphFromNodeWays(ways); @@ -641,6 +639,5 @@ // graph built up from way segments is likely to include such // nodes, unless all ways are closed. - // In the worst case this loops over all nodes which is - // very slow for large ways. + // In the worst case this loops over all nodes which is very slow for large ways. // Set nodes = getTerminalNodes(); Index: trunk/src/org/openstreetmap/josm/actions/JoinAreasAction.java =================================================================== --- trunk/src/org/openstreetmap/josm/actions/JoinAreasAction.java (revision 8456) +++ trunk/src/org/openstreetmap/josm/actions/JoinAreasAction.java (revision 8459) @@ -1002,6 +1002,6 @@ * Collects outer way and corresponding inner ways from all boundaries. * @param level depth level - * @param boundaryWays - * @return the outermostWay. + * @param boundaryWays list of joined boundaries to search in + * @return the outermost Way. */ private List findOuterWaysImpl(int level, Collection boundaryWays) { Index: trunk/src/org/openstreetmap/josm/actions/OpenLocationAction.java =================================================================== --- trunk/src/org/openstreetmap/josm/actions/OpenLocationAction.java (revision 8456) +++ trunk/src/org/openstreetmap/josm/actions/OpenLocationAction.java (revision 8459) @@ -80,5 +80,5 @@ * Restore the current history from the preferences * - * @param cbHistory + * @param cbHistory the history combo box */ protected void restoreUploadAddressHistory(HistoryComboBox cbHistory) { @@ -93,5 +93,5 @@ /** * Remind the current history in the preferences - * @param cbHistory + * @param cbHistory the history combo box */ protected void remindUploadAddressHistory(HistoryComboBox cbHistory) { Index: trunk/src/org/openstreetmap/josm/actions/OrthogonalizeAction.java =================================================================== --- trunk/src/org/openstreetmap/josm/actions/OrthogonalizeAction.java (revision 8456) +++ trunk/src/org/openstreetmap/josm/actions/OrthogonalizeAction.java (revision 8459) @@ -419,5 +419,5 @@ * heading of the entire way. * @param pInitialDirection initial direction - * @throws InvalidUserInputException + * @throws InvalidUserInputException if selected ways have an angle different from 90 or 180 degrees */ public void calcDirections(Direction pInitialDirection) throws InvalidUserInputException { Index: trunk/src/org/openstreetmap/josm/actions/RestartAction.java =================================================================== --- trunk/src/org/openstreetmap/josm/actions/RestartAction.java (revision 8456) +++ trunk/src/org/openstreetmap/josm/actions/RestartAction.java (revision 8459) @@ -75,5 +75,5 @@ /** * Restarts the current Java application - * @throws IOException + * @throws IOException in case of any error */ public static void restartJOSM() throws IOException { Index: trunk/src/org/openstreetmap/josm/actions/SimplifyWayAction.java =================================================================== --- trunk/src/org/openstreetmap/josm/actions/SimplifyWayAction.java (revision 8456) +++ trunk/src/org/openstreetmap/josm/actions/SimplifyWayAction.java (revision 8459) @@ -166,4 +166,5 @@ * * @param w the way to simplify + * @param threshold the max error threshold * @return The sequence of commands to run * @since 6411 @@ -187,5 +188,5 @@ } // ... and simplify them - buildSimplifiedNodeList(w.getNodes(), lower, Math.min(w.getNodesCount()-1, i), threshold,newNodes); + buildSimplifiedNodeList(w.getNodes(), lower, Math.min(w.getNodesCount()-1, i), threshold, newNodes); lower=i; i++; @@ -214,5 +215,5 @@ * @param from the lower index * @param to the upper index - * @param threshold + * @param threshold the max error threshold */ protected void buildSimplifiedNodeList(List wnew, int from, int to, double threshold, List simplifiedNodes) { Index: trunk/src/org/openstreetmap/josm/actions/mapmode/ParallelWays.java =================================================================== --- trunk/src/org/openstreetmap/josm/actions/mapmode/ParallelWays.java (revision 8456) +++ trunk/src/org/openstreetmap/josm/actions/mapmode/ParallelWays.java (revision 8459) @@ -126,5 +126,5 @@ /** * Offsets the way(s) d units. Positive d means to the left (relative to the reference way) - * @param d + * @param d offset */ public void changeOffset(double d) { Index: trunk/src/org/openstreetmap/josm/data/cache/JCSCachedTileLoaderJob.java =================================================================== --- trunk/src/org/openstreetmap/josm/data/cache/JCSCachedTileLoaderJob.java (revision 8456) +++ trunk/src/org/openstreetmap/josm/data/cache/JCSCachedTileLoaderJob.java (revision 8459) @@ -114,8 +114,8 @@ /** * @param cache cache instance that we will work on - * @param headers - * @param readTimeout - * @param connectTimeout - * @param downloadJobExecutor + * @param headers HTTP headers to be sent together with request + * @param readTimeout when connecting to remote resource + * @param connectTimeout when connecting to remote resource + * @param downloadJobExecutor that will be executing the jobs */ public JCSCachedTileLoaderJob(ICacheAccess cache, @@ -134,7 +134,7 @@ /** * @param cache cache instance that we will work on - * @param headers - * @param readTimeout - * @param connectTimeout + * @param headers HTTP headers to be sent together with request + * @param readTimeout when connecting to remote resource + * @param connectTimeout when connecting to remote resource */ public JCSCachedTileLoaderJob(ICacheAccess cache, Index: trunk/src/org/openstreetmap/josm/data/imagery/ImageryInfo.java =================================================================== --- trunk/src/org/openstreetmap/josm/data/imagery/ImageryInfo.java (revision 8456) +++ trunk/src/org/openstreetmap/josm/data/imagery/ImageryInfo.java (revision 8459) @@ -1023,8 +1023,8 @@ /** - * Sets the Map of <header name, header value> that if any of this header + * Sets the map of <header name, header value> that if any of this header * will be returned, then this tile will be treated as "no tile at this zoom level" * - * @param noTileHeaders + * @param noTileHeaders Map of <header name, header value> which will be treated as "no tile at this zoom level" * @since 8344 */ @@ -1039,8 +1039,8 @@ /** - * Returns the map <header name, metadata key> indicating, which HTTP headers should + * Returns the map of <header name, metadata key> indicating, which HTTP headers should * be moved to metadata * - * @param metadataHeaders + * @param metadataHeaders map of <header name, metadata key> indicating, which HTTP headers should be moved to metadata * @since 8418 */ Index: trunk/src/org/openstreetmap/josm/data/imagery/TMSCachedTileLoader.java =================================================================== --- trunk/src/org/openstreetmap/josm/data/imagery/TMSCachedTileLoader.java (revision 8456) +++ trunk/src/org/openstreetmap/josm/data/imagery/TMSCachedTileLoader.java (revision 8459) @@ -29,14 +29,15 @@ public class TMSCachedTileLoader implements TileLoader, CachedTileLoader, TileCache { - private ICacheAccess cache; - private int connectTimeout; - private int readTimeout; - private Map headers; - private TileLoaderListener listener; + private final ICacheAccess cache; + private final int connectTimeout; + private final int readTimeout; + private final Map headers; + private final TileLoaderListener listener; private static final String PREFERENCE_PREFIX = "imagery.tms.cache."; + /** - * how many object on disk should be stored for TMS region. Average tile size is about 20kb + * how many object on disk should be stored for TMS region. Average tile size is about 20kb. 25000 is around 500MB under this assumption */ - public static final IntegerProperty MAX_OBJECTS_ON_DISK = new IntegerProperty(PREFERENCE_PREFIX + "max_objects_disk", 25000); // 25000 is around 500MB under this assumptions + public static final IntegerProperty MAX_OBJECTS_ON_DISK = new IntegerProperty(PREFERENCE_PREFIX + "max_objects_disk", 25000); /** @@ -50,5 +51,4 @@ public static final IntegerProperty HOST_LIMIT = new IntegerProperty("imagery.tms.tmsloader.maxjobsperhost", 6); - /** * separate from JCS thread pool for TMS loader, so we can have different thread pools for default JCS @@ -56,4 +56,6 @@ */ private static ThreadPoolExecutor DEFAULT_DOWNLOAD_JOB_DISPATCHER = getThreadPoolExecutor(); + + private final ThreadPoolExecutor downloadExecutor = DEFAULT_DOWNLOAD_JOB_DISPATCHER; private static ThreadPoolExecutor getThreadPoolExecutor() { @@ -68,6 +70,4 @@ } - private ThreadPoolExecutor downloadExecutor = DEFAULT_DOWNLOAD_JOB_DISPATCHER; - /** * Constructor @@ -76,5 +76,5 @@ * @param connectTimeout to remote resource * @param readTimeout to remote resource - * @param headers to be sent along with request + * @param headers HTTP headers to be sent along with request * @param cacheDir where cache file shall reside * @throws IOException when cache initialization fails Index: trunk/src/org/openstreetmap/josm/data/imagery/TMSCachedTileLoaderJob.java =================================================================== --- trunk/src/org/openstreetmap/josm/data/imagery/TMSCachedTileLoaderJob.java (revision 8456) +++ trunk/src/org/openstreetmap/josm/data/imagery/TMSCachedTileLoaderJob.java (revision 8459) @@ -52,10 +52,10 @@ /** * Constructor for creating a job, to get a specific tile from cache - * @param listener + * @param listener Tile loader listener * @param tile to be fetched from cache * @param cache object * @param connectTimeout when connecting to remote resource * @param readTimeout when connecting to remote resource - * @param headers to be sent together with request + * @param headers HTTP headers to be sent together with request * @param downloadExecutor that will be executing the jobs */ Index: trunk/src/org/openstreetmap/josm/gui/FileDrop.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/FileDrop.java (revision 8456) +++ trunk/src/org/openstreetmap/josm/gui/FileDrop.java (revision 8459) @@ -34,4 +34,5 @@ import org.openstreetmap.josm.Main; import org.openstreetmap.josm.actions.OpenFileAction; +import org.openstreetmap.josm.gui.FileDrop.TransferableObject; /** @@ -538,6 +539,6 @@ * {@link #DATA_FLAVOR}. * + * @param fetcher The {@link Fetcher} that will return the data object * @see Fetcher - * @param fetcher The {@link Fetcher} that will return the data object */ public TransferableObject(Fetcher fetcher) { Index: trunk/src/org/openstreetmap/josm/gui/MenuScroller.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/MenuScroller.java (revision 8456) +++ trunk/src/org/openstreetmap/josm/gui/MenuScroller.java (revision 8459) @@ -151,7 +151,7 @@ * @param interval the scroll interval, in milliseconds * @param topFixedCount the number of items to fix at the top. May be 0. + * @return the MenuScroller * @throws IllegalArgumentException if scrollCount or interval is 0 or * negative or if topFixedCount is negative - * @return the MenuScroller * @since 7463 */ @@ -167,7 +167,7 @@ * @param interval the scroll interval, in milliseconds * @param topFixedCount the number of items to fix at the top. May be 0 + * @return the MenuScroller * @throws IllegalArgumentException if scrollCount or interval is 0 or * negative or if topFixedCount is negative - * @return the MenuScroller * @since 7463 */ Index: trunk/src/org/openstreetmap/josm/gui/NavigatableComponent.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/NavigatableComponent.java (revision 8456) +++ trunk/src/org/openstreetmap/josm/gui/NavigatableComponent.java (revision 8459) @@ -822,7 +822,4 @@ * * Finally, if a node is not found at all, null is returned. - * @since 6065 - * @return A node within snap-distance to point p, - * that is chosen by the algorithm described. * * @param p the screen point @@ -830,4 +827,8 @@ * give the nearest node that is tagged. * @param preferredRefs primitives, whose nodes we prefer + * + * @return A node within snap-distance to point p, + * that is chosen by the algorithm described. + * @since 6065 */ public final Node getNearestNode(Point p, Predicate predicate, @@ -1009,11 +1010,11 @@ * The *result* depends on the current map selection state IF use_selected is true. * + * @param p the point for which to search the nearest segment. + * @param predicate the returned object has to fulfill certain properties. + * @param useSelected whether selected way segments should be preferred. + * * @return The nearest way segment to point p, * and, depending on use_selected, prefers a selected way segment, if found. * @see #getNearestWaySegments(Point, Collection, Predicate) - * - * @param p the point for which to search the nearest segment. - * @param predicate the returned object has to fulfill certain properties. - * @param useSelected whether selected way segments should be preferred. */ public final WaySegment getNearestWaySegment(Point p, Predicate predicate, boolean useSelected) { @@ -1040,13 +1041,15 @@ * The *result* depends on the current map selection state IF use_selected is true. * - * @return The nearest way segment to point p, - * and, depending on use_selected, prefers a selected way segment, if found. - * Also prefers segments of ways that are related to one of preferredRefs primitives - * @see #getNearestWaySegments(Point, Collection, Predicate) - * @since 6065 * @param p the point for which to search the nearest segment. * @param predicate the returned object has to fulfill certain properties. * @param use_selected whether selected way segments should be preferred. * @param preferredRefs - prefer segments related to these primitives, may be null + * + * @return The nearest way segment to point p, + * and, depending on use_selected, prefers a selected way segment, if found. + * Also prefers segments of ways that are related to one of preferredRefs primitives + * + * @see #getNearestWaySegments(Point, Collection, Predicate) + * @since 6065 */ public final WaySegment getNearestWaySegment(Point p, Predicate predicate, @@ -1150,10 +1153,9 @@ * The *result* depends on the current map selection state. * - * @return The nearest way to point p, - * prefer a selected way if there are multiple nearest. - * @see #getNearestWaySegment(Point, Predicate) - * * @param p the point for which to search the nearest segment. * @param predicate the returned object has to fulfill certain properties. + * + * @return The nearest way to point p, prefer a selected way if there are multiple nearest. + * @see #getNearestWaySegment(Point, Predicate) */ public final Way getNearestWay(Point p, Predicate predicate) { @@ -1249,12 +1251,12 @@ * Finally, if no nearest primitive is found at all, return null. * + * @param p The point on screen. + * @param predicate the returned object has to fulfill certain properties. + * @param use_selected whether to prefer primitives that are currently selected or referred by selected primitives + * * @return A primitive within snap-distance to point p, * that is chosen by the algorithm described. * @see #getNearestNode(Point, Predicate) * @see #getNearestWay(Point, Predicate) - * - * @param p The point on screen. - * @param predicate the returned object has to fulfill certain properties. - * @param use_selected whether to prefer primitives that are currently selected or referred by selected primitives */ public final OsmPrimitive getNearestNodeOrWay(Point p, Predicate predicate, boolean use_selected) { @@ -1346,14 +1348,13 @@ /** - * The *result* does not depend on the current map selection state, - * neither does the result *order*. + * The *result* does not depend on the current map selection state, neither does the result *order*. * It solely depends on the distance to point p. - * - * @return a list of all objects that are nearest to point p and - * not in ignore or an empty list if nothing was found. * * @param p The point on screen. * @param ignore a collection of ways which are not to be returned. * @param predicate the returned object has to fulfill certain properties. + * + * @return a list of all objects that are nearest to point p and + * not in ignore or an empty list if nothing was found. */ public final List getAllNearest(Point p, @@ -1395,14 +1396,13 @@ /** - * The *result* does not depend on the current map selection state, - * neither does the result *order*. + * The *result* does not depend on the current map selection state, neither does the result *order*. * It solely depends on the distance to point p. + * + * @param p The point on screen. + * @param predicate the returned object has to fulfill certain properties. * * @return a list of all objects that are nearest to point p * or an empty list if nothing was found. * @see #getAllNearest(Point, Collection, Predicate) - * - * @param p The point on screen. - * @param predicate the returned object has to fulfill certain properties. */ public final List getAllNearest(Point p, Predicate predicate) { Index: trunk/src/org/openstreetmap/josm/gui/mappaint/Environment.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/mappaint/Environment.java (revision 8456) +++ trunk/src/org/openstreetmap/josm/gui/mappaint/Environment.java (revision 8459) @@ -148,7 +148,7 @@ * @param count count of nodes in parent way or members in parent relation * @return A clone of this environment, with the specified child, index, and context set to {@code Context#LINK} - * @since 6175 * @see #child * @see #index + * @since 6175 */ public Environment withChildAndIndexAndLinkContext(OsmPrimitive child, int index, int count) { Index: trunk/src/org/openstreetmap/josm/gui/mappaint/mapcss/ExpressionFactory.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/mappaint/mapcss/ExpressionFactory.java (revision 8456) +++ trunk/src/org/openstreetmap/josm/gui/mappaint/mapcss/ExpressionFactory.java (revision 8459) @@ -578,6 +578,6 @@ * {@code sw}, {@code southwest}, {@code w}, {@code west}, {@code nw}, {@code northwest}. * @param cardinal the angle in cardinal directions. + * @return the angle in radians * @see RotationAngle#parseCardinalRotation(String) - * @return the angle in radians */ public static Double cardinal_to_radians(String cardinal) { Index: trunk/src/org/openstreetmap/josm/tools/Geometry.java =================================================================== --- trunk/src/org/openstreetmap/josm/tools/Geometry.java (revision 8456) +++ trunk/src/org/openstreetmap/josm/tools/Geometry.java (revision 8459) @@ -411,6 +411,6 @@ * @return segmentP1 if it is the closest point, segmentP2 if it is the closest point, * a new point if closest point is between segmentP1 and segmentP2. + * @see #closestPointToLine * @since 3650 - * @see #closestPointToLine */ public static EastNorth closestPointToSegment(EastNorth segmentP1, EastNorth segmentP2, EastNorth point) { Index: trunk/src/org/openstreetmap/josm/tools/ImageProvider.java =================================================================== --- trunk/src/org/openstreetmap/josm/tools/ImageProvider.java (revision 8456) +++ trunk/src/org/openstreetmap/josm/tools/ImageProvider.java (revision 8459) @@ -381,6 +381,6 @@ * Set image width * @param width final width of the image + * @return the current object, for convenience * @see #setSize - * @return the current object, for convenience */ public ImageProvider setWidth(int width) { @@ -392,6 +392,6 @@ * Set image height * @param height final height of the image + * @return the current object, for convenience * @see #setSize - * @return the current object, for convenience */ public ImageProvider setHeight(int height) { @@ -1353,6 +1353,6 @@ * @throws IllegalArgumentException if input is null. * @throws IOException if an error occurs during reading. + * @see BufferedImage#getProperty * @since 7132 - * @see BufferedImage#getProperty */ public static BufferedImage read(File input, boolean readMetadata, boolean enforceTransparency) throws IOException {