Index: trunk/src/org/openstreetmap/josm/actions/DownloadAlongAction.java
===================================================================
--- trunk/src/org/openstreetmap/josm/actions/DownloadAlongAction.java (revision 8928)
+++ trunk/src/org/openstreetmap/josm/actions/DownloadAlongAction.java (revision 8929)
@@ -10,6 +10,4 @@
import java.util.Collection;
import java.util.List;
-import java.util.concurrent.CancellationException;
-import java.util.concurrent.ExecutionException;
import java.util.concurrent.Future;
Index: trunk/src/org/openstreetmap/josm/gui/progress/ProgressMonitor.java
===================================================================
--- trunk/src/org/openstreetmap/josm/gui/progress/ProgressMonitor.java (revision 8928)
+++ trunk/src/org/openstreetmap/josm/gui/progress/ProgressMonitor.java (revision 8929)
@@ -134,4 +134,5 @@
* @param ticks Number of work units that should be done when subtask finishes
* @param internal If true then subtask can't modify task title/custom text
+ * @return subtasks monitor
*/
ProgressMonitor createSubTaskMonitor(int ticks, boolean internal);
Index: trunk/src/org/openstreetmap/josm/gui/util/GuiHelper.java
===================================================================
--- trunk/src/org/openstreetmap/josm/gui/util/GuiHelper.java (revision 8928)
+++ trunk/src/org/openstreetmap/josm/gui/util/GuiHelper.java (revision 8929)
@@ -316,4 +316,5 @@
/**
* Gets the font used to display JOSM title in about dialog and splash screen.
+ * @return title font
* @since 5797
*/
Index: trunk/src/org/openstreetmap/josm/gui/util/HighlightHelper.java
===================================================================
--- trunk/src/org/openstreetmap/josm/gui/util/HighlightHelper.java (revision 8928)
+++ trunk/src/org/openstreetmap/josm/gui/util/HighlightHelper.java (revision 8929)
@@ -23,4 +23,5 @@
* Highlight and remember given primitives
* @param prims - primitives to highlight/unhighlight
+ * @return {@code true} if a repaint is needed
*/
public boolean highlight(Collection prims) {
@@ -32,4 +33,5 @@
* @param prims - primitives to highlight/unhighlight
* @param only - remove previous highlighting
+ * @return {@code true} if a repaint is needed
*/
public boolean highlight(Collection prims, boolean only) {
@@ -56,4 +58,5 @@
* Highlight and remember given primitives, forgetting previously highlighted by this instance
* @param prims - primitives to highlight/unhighlight
+ * @return {@code true} if a repaint is needed
*/
public boolean highlightOnly(Collection prims) {
@@ -64,4 +67,5 @@
* Highlight and remember given primitive, forgetting previously highlighted by this instance
* @param p - primitives to highlight/unhighlight
+ * @return {@code true} if a repaint is needed
*/
public boolean highlightOnly(OsmPrimitive p) {
@@ -73,4 +77,5 @@
* @param p - primitive to highlight/unhighlight
* @param flag - true to highlight
+ * @return {@code true} if a repaint is needed
*/
public boolean setHighlight(OsmPrimitive p, boolean flag) {
Index: trunk/src/org/openstreetmap/josm/gui/util/RotationAngle.java
===================================================================
--- trunk/src/org/openstreetmap/josm/gui/util/RotationAngle.java (revision 8928)
+++ trunk/src/org/openstreetmap/josm/gui/util/RotationAngle.java (revision 8929)
@@ -15,6 +15,9 @@
*/
public abstract class RotationAngle {
+
/**
* Calculates the rotation angle depending on the primitive to displayed.
+ * @param p primitive
+ * @return rotation angle
*/
public abstract double getRotationAngle(OsmPrimitive p);
@@ -22,4 +25,6 @@
/**
* Always returns the fixed {@code angle}.
+ * @param angle angle
+ * @return rotation angle
*/
public static RotationAngle buildStaticRotation(final double angle) {
@@ -39,4 +44,6 @@
/**
* Parses the rotation angle from the specified {@code string}.
+ * @param string angle as string
+ * @return rotation angle
*/
public static RotationAngle buildStaticRotation(final String string) {
@@ -89,4 +96,5 @@
/**
* Computes the angle depending on the referencing way segment, or {@code 0} if none exists.
+ * @return rotation angle
*/
public static RotationAngle buildWayDirectionRotation() {
Index: trunk/src/org/openstreetmap/josm/gui/widgets/DisableShortcutsOnFocusGainedTextField.java
===================================================================
--- trunk/src/org/openstreetmap/josm/gui/widgets/DisableShortcutsOnFocusGainedTextField.java (revision 8928)
+++ trunk/src/org/openstreetmap/josm/gui/widgets/DisableShortcutsOnFocusGainedTextField.java (revision 8929)
@@ -158,4 +158,6 @@
/**
* Returns true if the given shortcut has no modifier and is not an actions key.
+ * @param ks key stroke
+ * @return {@code true} if the given shortcut has to be disabled
* @see KeyEvent#isActionKey()
*/
Index: trunk/src/org/openstreetmap/josm/gui/widgets/QuadStateCheckBox.java
===================================================================
--- trunk/src/org/openstreetmap/josm/gui/widgets/QuadStateCheckBox.java (revision 8928)
+++ trunk/src/org/openstreetmap/josm/gui/widgets/QuadStateCheckBox.java (revision 8929)
@@ -158,4 +158,5 @@
* selected and armed (grey) and NOT_SELECTED when the
* checkbox is deselected.
+ * @return current state
*/
private State getState() {
Index: trunk/src/org/openstreetmap/josm/io/BoundingBoxDownloader.java
===================================================================
--- trunk/src/org/openstreetmap/josm/io/BoundingBoxDownloader.java (revision 8928)
+++ trunk/src/org/openstreetmap/josm/io/BoundingBoxDownloader.java (revision 8929)
@@ -114,4 +114,5 @@
/**
* Returns the name of the download task to be displayed in the {@link ProgressMonitor}.
+ * @return task name
*/
protected String getTaskName() {
@@ -121,4 +122,9 @@
/**
* Builds the request part for the bounding box.
+ * @param lon1 left
+ * @param lat1 bottom
+ * @param lon2 right
+ * @param lat2 top
+ * @return "map?bbox=left,bottom,right,top"
*/
protected String getRequestForBbox(double lon1, double lat1, double lon2, double lat2) {
@@ -128,4 +134,7 @@
/**
* Parse the given input source and return the dataset.
+ * @param source input stream
+ * @param progressMonitor progress monitor
+ * @return dataset
* @throws IllegalDataException if an error was found while parsing the OSM data
*
Index: trunk/src/org/openstreetmap/josm/io/CachedFile.java
===================================================================
--- trunk/src/org/openstreetmap/josm/io/CachedFile.java (revision 8928)
+++ trunk/src/org/openstreetmap/josm/io/CachedFile.java (revision 8929)
@@ -351,4 +351,7 @@
* 2 resources that point to the same url, but that are to be stored in different
* directories will not share a cache file.
+ * @param url URL
+ * @param destDir destination directory
+ * @return Preference key
*/
private static String getPrefKey(URL url, String destDir) {
Index: trunk/src/org/openstreetmap/josm/io/Compression.java
===================================================================
--- trunk/src/org/openstreetmap/josm/io/Compression.java (revision 8928)
+++ trunk/src/org/openstreetmap/josm/io/Compression.java (revision 8929)
@@ -54,4 +54,6 @@
/**
* Returns an un-compressing {@link InputStream} for {@code in}.
+ * @param in raw input stream
+ * @return un-compressing input stream
*
* @throws IOException if any I/O error occurs
@@ -73,5 +75,6 @@
/**
* Returns an un-compressing {@link InputStream} for the {@link File} {@code file}.
- *
+ * @param file file
+ * @return un-compressing input stream
* @throws IOException if any I/O error occurs
*/
@@ -83,4 +86,6 @@
/**
* Returns an un-compressing {@link InputStream} for the {@link URL} {@code url}.
+ * @param url URL
+ * @return un-compressing input stream
*
* @throws IOException if any I/O error occurs
@@ -92,4 +97,6 @@
/**
* Returns a compressing {@link OutputStream} for {@code out}.
+ * @param out raw output stream
+ * @return compressing output stream
*
* @throws IOException if any I/O error occurs
@@ -111,4 +118,6 @@
/**
* Returns a compressing {@link OutputStream} for the {@link File} {@code file}.
+ * @param file file
+ * @return compressing output stream
*
* @throws IOException if any I/O error occurs
Index: trunk/src/org/openstreetmap/josm/io/FileImporter.java
===================================================================
--- trunk/src/org/openstreetmap/josm/io/FileImporter.java (revision 8928)
+++ trunk/src/org/openstreetmap/josm/io/FileImporter.java (revision 8929)
@@ -142,4 +142,5 @@
* they are opened in the order of their priorities.
* Highest priority comes first.
+ * @return priority
*/
public double getPriority() {
Index: trunk/src/org/openstreetmap/josm/io/OsmImporter.java
===================================================================
--- trunk/src/org/openstreetmap/josm/io/OsmImporter.java (revision 8928)
+++ trunk/src/org/openstreetmap/josm/io/OsmImporter.java (revision 8929)
@@ -113,4 +113,5 @@
* @param layerName name of generated layer
* @param progressMonitor handler for progress monitoring and canceling
+ * @return Utility class containing imported OSM layer, and a task to run after it is added to MapView
* @throws IllegalDataException if an error was found while parsing the OSM data
*/
Index: trunk/src/org/openstreetmap/josm/io/XmlWriter.java
===================================================================
--- trunk/src/org/openstreetmap/josm/io/XmlWriter.java (revision 8928)
+++ trunk/src/org/openstreetmap/josm/io/XmlWriter.java (revision 8929)
@@ -43,4 +43,5 @@
* new JLabel("<html>'</html>")
* literally as 6 character string, see #7558)
+ * @return XML1.0 string
*/
public static String encode(String unencoded, boolean keepApos) {
Index: trunk/src/org/openstreetmap/josm/io/auth/AbstractCredentialsAgent.java
===================================================================
--- trunk/src/org/openstreetmap/josm/io/auth/AbstractCredentialsAgent.java (revision 8928)
+++ trunk/src/org/openstreetmap/josm/io/auth/AbstractCredentialsAgent.java (revision 8929)
@@ -96,4 +96,5 @@
* Provide the text for a checkbox that offers to save the
* username and password that has been entered by the user.
+ * @return checkbox text
*/
public abstract String getSaveUsernameAndPasswordCheckboxText();
Index: trunk/src/org/openstreetmap/josm/io/auth/CredentialsAgent.java
===================================================================
--- trunk/src/org/openstreetmap/josm/io/auth/CredentialsAgent.java (revision 8928)
+++ trunk/src/org/openstreetmap/josm/io/auth/CredentialsAgent.java (revision 8929)
@@ -44,5 +44,5 @@
/**
- *
+ * Returns the credentials needed to to access host.
* @param requestorType the type of service. {@link RequestorType#SERVER} for the OSM API server, {@link RequestorType#PROXY}
* for a proxy server
@@ -50,6 +50,6 @@
* @param noSuccessWithLastResponse true, if the last request with the supplied credentials failed; false otherwise.
* If true, implementations of this interface are advised to prompt the user for new credentials.
+ * @return the credentials
* @throws CredentialsAgentException if a problem occurs in a implementation of this interface
-
*/
CredentialsAgentResponse getCredentials(RequestorType requestorType, String host, boolean noSuccessWithLastResponse)
@@ -73,10 +73,9 @@
void storeOAuthAccessToken(OAuthToken accessToken) throws CredentialsAgentException;
-
/**
* Provide a Panel that is shown below the API password / username fields
* in the JOSM Preferences. (E.g. a warning that password is saved unencrypted.)
+ * @return Panel
*/
Component getPreferencesDecorationPanel();
-
}
Index: trunk/src/org/openstreetmap/josm/io/remotecontrol/handler/AddWayHandler.java
===================================================================
--- trunk/src/org/openstreetmap/josm/io/remotecontrol/handler/AddWayHandler.java (revision 8928)
+++ trunk/src/org/openstreetmap/josm/io/remotecontrol/handler/AddWayHandler.java (revision 8929)
@@ -120,5 +120,7 @@
/**
- * Find the node with almost the same ccords in dataset or in already added nodes
+ * Find the node with almost the same coords in dataset or in already added nodes
+ * @param ll coordinates
+ * @return node with almost the same coords
* @since 5845
*/
Index: trunk/src/org/openstreetmap/josm/io/remotecontrol/handler/RequestHandler.java
===================================================================
--- trunk/src/org/openstreetmap/josm/io/remotecontrol/handler/RequestHandler.java (revision 8928)
+++ trunk/src/org/openstreetmap/josm/io/remotecontrol/handler/RequestHandler.java (revision 8929)
@@ -200,4 +200,7 @@
/**
+ * Returns the request parameters.
+ * @param uri URI as string
+ * @return map of request parameters
* @see
* What every web developer must know about URL encoding
Index: trunk/src/org/openstreetmap/josm/io/session/SessionReader.java
===================================================================
--- trunk/src/org/openstreetmap/josm/io/session/SessionReader.java (revision 8928)
+++ trunk/src/org/openstreetmap/josm/io/session/SessionReader.java (revision 8929)
@@ -171,4 +171,6 @@
* - relativ to the .joz file:
* "../save/data.osm" ("../" steps out of the archive)
+ * @param uriStr URI as string
+ * @return the InputStream
*
* @throws IOException Thrown when no Stream can be opened for the given URI, e.g. when the linked file has been deleted.
@@ -246,4 +248,5 @@
/**
* Name of the layer that is currently imported.
+ * @return layer name
*/
public String getLayerName() {
@@ -253,4 +256,5 @@
/**
* Index of the layer that is currently imported.
+ * @return layer index
*/
public int getLayerIndex() {
@@ -261,4 +265,5 @@
* Dependencies - maps the layer index to the importer of the given
* layer. All the dependent importers have loaded completely at this point.
+ * @return layer dependencies
*/
public List getLayerDependencies() {