Index: /trunk/src/org/openstreetmap/josm/gui/history/DiffTableModel.java =================================================================== --- /trunk/src/org/openstreetmap/josm/gui/history/DiffTableModel.java (revision 5862) +++ /trunk/src/org/openstreetmap/josm/gui/history/DiffTableModel.java (revision 5863) @@ -10,7 +10,6 @@ /** - * Simple model storing "diff cells" in a list. Could probably have used a DefaultTableModel instead.. - * - * {@link NodeListDiffTableCellRenderer} + * Simple model storing "diff cells" in a list. Could probably have + * used a {@link javax.swing.table.DefaultTableModel} instead. */ class DiffTableModel extends AbstractTableModel { Index: /trunk/src/org/openstreetmap/josm/gui/history/HistoryLoadTask.java =================================================================== --- /trunk/src/org/openstreetmap/josm/gui/history/HistoryLoadTask.java (revision 5862) +++ /trunk/src/org/openstreetmap/josm/gui/history/HistoryLoadTask.java (revision 5863) @@ -61,7 +61,8 @@ * Creates a new task * - * @param parent the component to be used as reference to find the parent for {@link PleaseWaitDialog}. - * Must not be null. - * @throws IllegalArgumentException thrown if parent is null + * @param parent the component to be used as reference to find the + * parent for {@link org.openstreetmap.josm.gui.PleaseWaitDialog}. + * Must not be null. + * @throws IllegalArgumentException thrown if parent is null */ public HistoryLoadTask(Component parent) { @@ -142,8 +143,9 @@ * Adds a collection of objects to loaded, specified by a collection of OSM primitives. * - * @param primitive the OSM primitive. Must not be null. primitive.getId() > 0 required. - * @return this task - * @throws IllegalArgumentException thrown if primitives is null - * @throws IllegalArgumentException thrown if one of the ids in the collection <= 0 + * @param primitives the OSM primitives. Must not be null. + * primitive.getId() > 0 required. + * @return this task + * @throws IllegalArgumentException thrown if primitives is null + * @throws IllegalArgumentException thrown if one of the ids in the collection <= 0 */ public HistoryLoadTask add(Collection primitives) { @@ -160,6 +162,7 @@ @Override protected void cancel() { - System.out.println("Cancel!"); - if (reader!=null) reader.cancel(); + if (reader != null) { + reader.cancel(); + } canceled = true; } Index: /trunk/src/org/openstreetmap/josm/io/OsmImporter.java =================================================================== --- /trunk/src/org/openstreetmap/josm/io/OsmImporter.java (revision 5862) +++ /trunk/src/org/openstreetmap/josm/io/OsmImporter.java (revision 5863) @@ -53,6 +53,7 @@ /** - * Imports OSM data from file @param file - * This method supports progress monitoring and canceling by using @param progressMonitor + * Imports OSM data from file + * @param file file to read data from + * @param progressMonitor handler for progress monitoring and canceling */ @Override @@ -73,5 +74,7 @@ /** - * Imports OSM data from stream @param in , sitle will be generated from name of file @param associatedFile + * Imports OSM data from stream + * @param in input stream + * @param associatedFile filename of data */ protected void importData(InputStream in, final File associatedFile) throws IllegalDataException { @@ -80,6 +83,8 @@ /** - * Imports OSM data from stream @param in , layer name will be generated from name of file @param associatedFile - * This method supports progress monitoring and canceling by using @param progressMonitor + * Imports OSM data from stream + * @param in input stream + * @param associatedFile filename of data (layer name will be generated from name of file) + * @param pm handler for progress monitoring and canceling */ protected void importData(InputStream in, final File associatedFile, ProgressMonitor pm) throws IllegalDataException { @@ -100,5 +105,8 @@ /** * Load osm data layer from InputStream. - * associatedFile can be null if the stream does not come from a file. + * @param in input stream + * @param associatedFile filename of data (can be null if the stream does not come from a file) + * @param layerName name of generated layer + * @param progressMonitor handler for progress monitoring and canceling */ public OsmImporterData loadLayer(InputStream in, final File associatedFile, final String layerName, ProgressMonitor progressMonitor) throws IllegalDataException { Index: /trunk/src/org/openstreetmap/josm/io/OsmServerReader.java =================================================================== --- /trunk/src/org/openstreetmap/josm/io/OsmServerReader.java (revision 5862) +++ /trunk/src/org/openstreetmap/josm/io/OsmServerReader.java (revision 5863) @@ -38,7 +38,9 @@ * Open a connection to the given url and return a reader on the input stream * from that connection. In case of user cancel, return null. - * @param urlStr The exact url to connect to. - * @param pleaseWaitDlg + * Relative URL's are directed to API base URL. + * @param urlStr The url to connect to. + * @param progressMonitor progress monitoring and abort handler * @return An reader reading the input stream (servers answer) or null. + * @throws OsmTransferException thrown if data transfer errors occur */ protected InputStream getInputStream(String urlStr, ProgressMonitor progressMonitor) throws OsmTransferException { @@ -52,8 +54,20 @@ } + /** + * Retrun the base URL for relative URL requests + * @return base url of API + */ protected String getBaseUrl() { return api.getBaseUrl(); } + /** + * Open a connection to the given url and return a reader on the input stream + * from that connection. In case of user cancel, return null. + * @param urlStr The exact url to connect to. + * @param progressMonitor progress monitoring and abort handler + * @return An reader reading the input stream (servers answer) or null. + * @throws OsmTransferException thrown if data transfer errors occur + */ protected InputStream getInputStreamRaw(String urlStr, ProgressMonitor progressMonitor) throws OsmTransferException { try { Index: /trunk/src/org/openstreetmap/josm/io/auth/AbstractCredentialsAgent.java =================================================================== --- /trunk/src/org/openstreetmap/josm/io/auth/AbstractCredentialsAgent.java (revision 5862) +++ /trunk/src/org/openstreetmap/josm/io/auth/AbstractCredentialsAgent.java (revision 5863) @@ -15,5 +15,5 @@ /** - * @see CredentialsAgent#getCredentials(RequestorType, String, boolean) + * @see CredentialsAgent#getCredentials */ @Override Index: /trunk/src/org/openstreetmap/josm/io/auth/JosmPreferencesCredentialAgent.java =================================================================== --- /trunk/src/org/openstreetmap/josm/io/auth/JosmPreferencesCredentialAgent.java (revision 5862) +++ /trunk/src/org/openstreetmap/josm/io/auth/JosmPreferencesCredentialAgent.java (revision 5863) @@ -25,5 +25,5 @@ /** - * @see CredentialsAgent#lookup(RequestorType) + * @see CredentialsAgent#lookup */ @Override @@ -59,5 +59,5 @@ /** - * @see CredentialsAgent#store(RequestorType, PasswordAuthentication) + * @see CredentialsAgent#store */ @Override Index: /trunk/src/org/openstreetmap/josm/tools/Diff.java =================================================================== --- /trunk/src/org/openstreetmap/josm/tools/Diff.java (revision 5862) +++ /trunk/src/org/openstreetmap/josm/tools/Diff.java (revision 5863) @@ -626,12 +626,12 @@ } - /** Mark to be discarded each line that matches no line of another file. - If a line matches many lines, mark it as provisionally discardable. - @see equivCount() - @param counts The count of each equivalence number for the other file. - @return 0=nondiscardable, 1=discardable or 2=provisionally discardable - for each line + /** + * Mark to be discarded each line that matches no line of another file. + * If a line matches many lines, mark it as provisionally discardable. + * @see #equivCount() + * @param counts The count of each equivalence number for the other file. + * @return 0=nondiscardable, 1=discardable or 2=provisionally discardable + * for each line */ - private byte[] discardable(final int[] counts) { final int end = buffered_lines; @@ -642,5 +642,5 @@ /* Multiply MANY by approximate square root of number of lines. - That is the threshold for provisionally discardable lines. */ + That is the threshold for provisionally discardable lines. */ while ((tem = tem >> 2) > 0) { many *= 2; @@ -663,8 +663,9 @@ } - /** Don't really discard the provisional lines except when they occur - in a run of discardables, with nonprovisionals at the beginning - and end. */ - + /** + * Don't really discard the provisional lines except when they occur + * in a run of discardables, with nonprovisionals at the beginning + * and end. + */ private void filterDiscards(final byte[] discards) { final int end = buffered_lines; Index: /trunk/src/org/openstreetmap/josm/tools/ImageProvider.java =================================================================== --- /trunk/src/org/openstreetmap/josm/tools/ImageProvider.java (revision 5862) +++ /trunk/src/org/openstreetmap/josm/tools/ImageProvider.java (revision 5863) @@ -341,5 +341,5 @@ /** * {@code data:[][;base64],} - * @see RFC2397 + * @see RFC2397 */ private static final Pattern dataUrlPattern = Pattern.compile( Index: /trunk/src/org/openstreetmap/josm/tools/OsmUrlToBounds.java =================================================================== --- /trunk/src/org/openstreetmap/josm/tools/OsmUrlToBounds.java (revision 5862) +++ /trunk/src/org/openstreetmap/josm/tools/OsmUrlToBounds.java (revision 5863) @@ -89,11 +89,9 @@ /** - * p + * Parse OSM short link * * @param url string for parsing - * * @return Bounds if shortlink, null otherwise - * - * @see http://trac.openstreetmap.org/browser/sites/rails_port/lib/short_link.rb + * @see short_link.rb */ private static Bounds parseShortLink(final String url) { @@ -146,4 +144,5 @@ } + /** radius of the earth */ public static final double R = 6378137.0; @@ -185,4 +184,10 @@ } + /** + * Return OSM Zoom level for a given area + * + * @param b bounds of the area + * @return matching zoom level for area + */ static public int getZoom(Bounds b) { // convert to mercator (for calculation of zoom only) @@ -201,8 +206,21 @@ } + /** + * Return OSM URL for given area + * + * @param b bounds of the area + * @return link to display that area in OSM map + */ static public String getURL(Bounds b) { return getURL(b.getCenter(), getZoom(b)); } + /** + * Return OSM URL for given position and zoom + * + * @param pos center position of area + * @param zoom zoom depth of display + * @return link to display that area in OSM map + */ static public String getURL(LatLon pos, int zoom) { // Truncate lat and lon to something more sensible