Index: trunk/src/org/openstreetmap/josm/Main.java
===================================================================
--- trunk/src/org/openstreetmap/josm/Main.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/Main.java (revision 655)
@@ -71,6 +71,6 @@
/**
* The worker thread slave. This is for executing all long and intensive
- * calculations. The executed runnables are guaranteed to be executed seperatly
- * and sequenciel.
+ * calculations. The executed runnables are guaranteed to be executed separately
+ * and sequential.
*/
public final static Executor worker = Executors.newSingleThreadExecutor();
@@ -286,5 +286,5 @@
/**
- * Add a new layer to the map. If no map exist, create one.
+ * Add a new layer to the map. If no map exists, create one.
*/
public final void addLayer(final Layer layer) {
@@ -299,5 +299,5 @@
}
/**
- * @return The edit osm layer. If none exist, it will be created.
+ * @return The edit osm layer. If none exists, it will be created.
*/
public final OsmDataLayer editLayer() {
Index: trunk/src/org/openstreetmap/josm/actions/AboutAction.java
===================================================================
--- trunk/src/org/openstreetmap/josm/actions/AboutAction.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/actions/AboutAction.java (revision 655)
@@ -154,5 +154,5 @@
/**
- * Load the specified ressource into an TextArea and return it.
+ * Load the specified resource into an TextArea and return it.
* @param resource The resource url to load
* @return An read-only text area with the content of "resource"
Index: trunk/src/org/openstreetmap/josm/actions/AlignInCircleAction.java
===================================================================
--- trunk/src/org/openstreetmap/josm/actions/AlignInCircleAction.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/actions/AlignInCircleAction.java (revision 655)
@@ -22,5 +22,5 @@
/**
- * Aligns all selected nodes within a circle. (Usefull for roundabouts)
+ * Aligns all selected nodes within a circle. (Useful for roundabouts)
*
* @author Matthew Newton
Index: trunk/src/org/openstreetmap/josm/actions/DiskAccessAction.java
===================================================================
--- trunk/src/org/openstreetmap/josm/actions/DiskAccessAction.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/actions/DiskAccessAction.java (revision 655)
@@ -12,5 +12,5 @@
/**
- * Helper class for all actions, that access the disk
+ * Helper class for all actions that access the disk
*/
abstract public class DiskAccessAction extends JosmAction {
Index: trunk/src/org/openstreetmap/josm/actions/DownloadAction.java
===================================================================
--- trunk/src/org/openstreetmap/josm/actions/DownloadAction.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/actions/DownloadAction.java (revision 655)
@@ -19,5 +19,5 @@
/**
- * Action that opens a connection to the osm server and download map data.
+ * Action that opens a connection to the osm server and downloads map data.
*
* An dialog is displayed asking the user to specify a rectangle to grab.
Index: trunk/src/org/openstreetmap/josm/actions/DuplicateAction.java
===================================================================
--- trunk/src/org/openstreetmap/josm/actions/DuplicateAction.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/actions/DuplicateAction.java (revision 655)
@@ -18,5 +18,5 @@
public DuplicateAction() {
super(tr("Duplicate"), "duplicate",
- tr("Duplicate selection by Copy and immediate Paste."),
+ tr("Duplicate selection by copy and immediate paste."),
KeyEvent.VK_D, KeyEvent.CTRL_MASK, true);
setEnabled(false);
Index: trunk/src/org/openstreetmap/josm/actions/ExitAction.java
===================================================================
--- trunk/src/org/openstreetmap/josm/actions/ExitAction.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/actions/ExitAction.java (revision 655)
@@ -10,5 +10,5 @@
/**
- * Exit the application. May ask for permition first (if something has changed).
+ * Exit the application. May ask for permission first (if something has changed).
*
* @author imi
Index: trunk/src/org/openstreetmap/josm/actions/HelpAction.java
===================================================================
--- trunk/src/org/openstreetmap/josm/actions/HelpAction.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/actions/HelpAction.java (revision 655)
@@ -149,5 +149,5 @@
/**
- * Displays the help (or browse on the already open help) to the online page
+ * Displays the help (or browse on the already open help) on the online page
* with the given help topic. Use this for larger help descriptions.
*/
Index: trunk/src/org/openstreetmap/josm/actions/OpenAction.java
===================================================================
--- trunk/src/org/openstreetmap/josm/actions/OpenAction.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/actions/OpenAction.java (revision 655)
@@ -26,5 +26,5 @@
/**
- * Open a file chooser dialog and select an file to import. Than call the gpx-import
+ * Open a file chooser dialog and select an file to import. Then call the gpx-import
* driver. Finally open an internal frame into the main window with the gpx data shown.
*
Index: trunk/src/org/openstreetmap/josm/actions/PasteTagsAction.java
===================================================================
--- trunk/src/org/openstreetmap/josm/actions/PasteTagsAction.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/actions/PasteTagsAction.java (revision 655)
@@ -76,5 +76,5 @@
/**
- * determines whether to enable the widget depending on the contents of the paste
+ * Determines whether to enable the widget depending on the contents of the paste
* buffer and current selection
* @param pasteBuffer
Index: trunk/src/org/openstreetmap/josm/actions/RedoAction.java
===================================================================
--- trunk/src/org/openstreetmap/josm/actions/RedoAction.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/actions/RedoAction.java (revision 655)
@@ -19,5 +19,5 @@
/**
- * Construct the action with "Undo" as label.
+ * Construct the action with "Redo" as label.
*/
public RedoAction() {
Index: trunk/src/org/openstreetmap/josm/actions/RenameLayerAction.java
===================================================================
--- trunk/src/org/openstreetmap/josm/actions/RenameLayerAction.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/actions/RenameLayerAction.java (revision 655)
@@ -30,5 +30,5 @@
/**
- * @param file The filen of the original location of this layer.
+ * @param file The file of the original location of this layer.
* If null, no possibility to "rename the file as well" is provided.
*/
Index: trunk/src/org/openstreetmap/josm/actions/SaveAction.java
===================================================================
--- trunk/src/org/openstreetmap/josm/actions/SaveAction.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/actions/SaveAction.java (revision 655)
@@ -13,5 +13,5 @@
/**
- * Export the data as OSM intern xml file.
+ * Export the data as an OSM xml file.
*
* @author imi
Index: trunk/src/org/openstreetmap/josm/actions/SaveActionBase.java
===================================================================
--- trunk/src/org/openstreetmap/josm/actions/SaveActionBase.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/actions/SaveActionBase.java (revision 655)
@@ -59,6 +59,6 @@
/**
* Checks whether it is ok to launch a save (whether we have data,
- * there is no conflict etc...)
- * @return true, if it is save to save.
+ * there is no conflict etc.)
+ * @return true, if it is safe to save.
*/
public boolean checkSaveConditions(Layer layer) {
@@ -211,5 +211,5 @@
/**
* Check the data set if it would be empty on save. It is empty, if it contains
- * no objects (after all objects that are created and deleted without beeing
+ * no objects (after all objects that are created and deleted without being
* transfered to the server have been removed).
*
Index: trunk/src/org/openstreetmap/josm/actions/SplitWayAction.java
===================================================================
--- trunk/src/org/openstreetmap/josm/actions/SplitWayAction.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/actions/SplitWayAction.java (revision 655)
@@ -169,8 +169,4 @@
/**
* Split a way into two or more parts, starting at a selected node.
- *
- * FIXME: what do the following "arguments" refer to?
- * @param way the way to split
- * @param nodes the node(s) to split the way at; must be part of the way.
*/
private void splitWay() {
Index: trunk/src/org/openstreetmap/josm/actions/UploadAction.java
===================================================================
--- trunk/src/org/openstreetmap/josm/actions/UploadAction.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/actions/UploadAction.java (revision 655)
@@ -26,5 +26,5 @@
/**
- * Action that opens a connection to the osm server and upload all changes.
+ * Action that opens a connection to the osm server and uploads all changes.
*
* An dialog is displayed asking the user to specify a rectangle to grab.
@@ -52,6 +52,6 @@
* if they want to be able to veto an upload.
*
- * Be dafault, the standard upload dialog is the only element in the list.
- * Plugins shold normally insert their code before that, so that the upload
+ * Be default, the standard upload dialog is the only element in the list.
+ * Plugins should normally insert their code before that, so that the upload
* dialog is the last thing shown before upload really starts; on occasion
* however, a plugin might also want to insert something after that.
Index: trunk/src/org/openstreetmap/josm/actions/mapmode/DeleteAction.java
===================================================================
--- trunk/src/org/openstreetmap/josm/actions/mapmode/DeleteAction.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/actions/mapmode/DeleteAction.java (revision 655)
@@ -31,8 +31,8 @@
* An action that enables the user to delete nodes and other objects.
*
- * The user can click on an object, which get deleted if possible. When Ctrl is
+ * The user can click on an object, which gets deleted if possible. When Ctrl is
* pressed when releasing the button, the objects and all its references are
- * deleted. The exact definition of "all its references" are in
- * @see #deleteWithReferences(OsmPrimitive)
+ * deleted. The exact definition of "all its references" are in
+ * {@link #deleteWithReferences deleteWithReferences}.
*
* If the user did not press Ctrl and the object has any references, the user
@@ -159,5 +159,5 @@
*
* @param selection The objects to delete.
- * @param alsoDeleteNodesInWay true if nodes should be deleted as well
+ * @param alsoDeleteNodesInWay true if nodes should be deleted as well
* @return command A command to perform the deletions, or null of there is
* nothing to delete.
Index: trunk/src/org/openstreetmap/josm/actions/mapmode/DrawAction.java
===================================================================
--- trunk/src/org/openstreetmap/josm/actions/mapmode/DrawAction.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/actions/mapmode/DrawAction.java (revision 655)
@@ -478,5 +478,5 @@
}
- /*
+ /**
* Adjusts the position of a node to lie on a segment (or a segment
* intersection).
Index: trunk/src/org/openstreetmap/josm/actions/mapmode/ExtrudeAction.java
===================================================================
--- trunk/src/org/openstreetmap/josm/actions/mapmode/ExtrudeAction.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/actions/mapmode/ExtrudeAction.java (revision 655)
@@ -53,5 +53,5 @@
private Cursor oldCursor;
/**
- * The curren tposition of the mouse
+ * The current position of the mouse
*/
private Point mousePos;
Index: trunk/src/org/openstreetmap/josm/actions/mapmode/SelectAction.java
===================================================================
--- trunk/src/org/openstreetmap/josm/actions/mapmode/SelectAction.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/actions/mapmode/SelectAction.java (revision 655)
@@ -29,5 +29,5 @@
import org.openstreetmap.josm.tools.ImageProvider;
/**
- * Move is an action that can move all kind of OsmPrimitives (except Keys for now).
+ * Move is an action that can move all kind of OsmPrimitives (except keys for now).
*
* If an selected object is under the mouse when dragging, move all selected objects.
Index: trunk/src/org/openstreetmap/josm/command/AddCommand.java
===================================================================
--- trunk/src/org/openstreetmap/josm/command/AddCommand.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/command/AddCommand.java (revision 655)
@@ -21,7 +21,7 @@
/**
* A command that adds an osm primitive to a dataset. Keys cannot be added this
- * way. Use ChangeKeyValueCommand instead.
+ * way.
*
- * See ChangeCommand for comments on relation back references.
+ * See {@link ChangeCommand ChangeCommand} for comments on relation back references.
*
* @author imi
Index: trunk/src/org/openstreetmap/josm/command/ChangePropertyCommand.java
===================================================================
--- trunk/src/org/openstreetmap/josm/command/ChangePropertyCommand.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/command/ChangePropertyCommand.java (revision 655)
@@ -26,5 +26,5 @@
public class ChangePropertyCommand extends Command {
/**
- * All primitives, that are affected with this command.
+ * All primitives that are affected with this command.
*/
private final List objects;
@@ -35,5 +35,5 @@
/**
* The key value. If it is null, delete all key references with the given
- * key. Else, change the properties of all objects to the given value or create keys of
+ * key. Otherwise, change the properties of all objects to the given value or create keys of
* those objects that do not have the key yet.
*/
Index: trunk/src/org/openstreetmap/josm/command/Command.java
===================================================================
--- trunk/src/org/openstreetmap/josm/command/Command.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/command/Command.java (revision 655)
@@ -25,5 +25,5 @@
* one atomic action on a specific dataset, such as move or delete.
*
- * Remember, that the command must be executable and undoable, even if the
+ * Remember that the command must be executable and undoable, even if the
* Main.ds has changed, so the command must save the dataset it operates on
* if necessary.
@@ -71,5 +71,5 @@
/**
* Undoes the command.
- * It can be assumed, that all objects are in the same state they were before.
+ * It can be assumed that all objects are in the same state they were before.
* It can also be assumed that executeCommand was called exactly once before.
*
@@ -82,5 +82,5 @@
/**
- * Called, when a layer has been removed to have the command remove itself from
+ * Called when a layer has been removed to have the command remove itself from
* any buffer if it is not longer applicable to the dataset (e.g. it was part of
* the removed layer)
@@ -123,7 +123,7 @@
* Add to the lists, don't clear them.
*
- * @param modified The modified primitives
- * @param deleted The deleted primitives
- * @param added The added primitives
+ * @param modified The modified primitives
+ * @param deleted The deleted primitives
+ * @param added The added primitives
*/
abstract public void fillModifiedData(Collection modified,
Index: trunk/src/org/openstreetmap/josm/command/MoveCommand.java
===================================================================
--- trunk/src/org/openstreetmap/josm/command/MoveCommand.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/command/MoveCommand.java (revision 655)
@@ -83,5 +83,5 @@
* vector plus this one.
*
- * The move is immediatly executed and any undo will undo both vectors to
+ * The move is immediately executed and any undo will undo both vectors to
* the original position the objects had before first moving.
*/
Index: trunk/src/org/openstreetmap/josm/command/SequenceCommand.java
===================================================================
--- trunk/src/org/openstreetmap/josm/command/SequenceCommand.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/command/SequenceCommand.java (revision 655)
@@ -14,5 +14,5 @@
/**
- * A command consisting of a sequenz of other commands. Executes the other commands
+ * A command consisting of a sequence of other commands. Executes the other commands
* and undo them in reverse order.
* @author imi
@@ -30,5 +30,5 @@
/**
* Create the command by specifying the list of commands to execute.
- * @param sequenz The sequenz that should be executed.
+ * @param sequenz The sequence that should be executed.
*/
public SequenceCommand(String name, Collection sequenz) {
@@ -39,5 +39,5 @@
/**
- * Convinient constructor, if the commands are known at compile time.
+ * Convenient constructor, if the commands are known at compile time.
*/
public SequenceCommand(String name, Command... sequenz) {
Index: trunk/src/org/openstreetmap/josm/data/Bounds.java
===================================================================
--- trunk/src/org/openstreetmap/josm/data/Bounds.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/data/Bounds.java (revision 655)
@@ -8,7 +8,4 @@
* This is a simple data class for "rectangular" areas of the world, given in
* lat/lon min/max values.
- *
- * Do not confuse this with "Area", which is an OSM-primitive for a vector of nodes,
- * describing some area (like a sea).
*
* @author imi
@@ -44,5 +41,5 @@
*/
public LatLon center() {
- // not sure, whether this calculation is right.. maybe there is some
+ // FIXME: not sure whether this calculation is right; maybe there is some
// more complex calculation needed to get a center of a spherical
// dimension?
Index: trunk/src/org/openstreetmap/josm/data/Preferences.java
===================================================================
--- trunk/src/org/openstreetmap/josm/data/Preferences.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/data/Preferences.java (revision 655)
@@ -78,5 +78,5 @@
/**
- * @return A list of all existing directories, where resources could be stored.
+ * @return A list of all existing directories where resources could be stored.
*/
public Collection getAllPossiblePreferenceDirs() {
Index: trunk/src/org/openstreetmap/josm/data/SelectionChangedListener.java
===================================================================
--- trunk/src/org/openstreetmap/josm/data/SelectionChangedListener.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/data/SelectionChangedListener.java (revision 655)
@@ -8,10 +8,10 @@
/**
* This is a listener for selection changes through the dataset's data. Whenever
- * a selection of any data meber changes, the dataSet gets informed about this
- * and fire a selectionChanged event.
+ * a selection of any data member changes, the dataSet gets informed about this
+ * and fires a selectionChanged event.
*
- * Note, that these events get not fired immediately but are inserted in the
- * Swing-event queue and packed together. So only one selection changed event
- * are issued within one message dispatch routine.
+ * Note that these events are not fired immediately but are inserted in the
+ * Swing event queue and packed together. So only one selection changed event
+ * is issued within a one message dispatch routine.
*
* @author imi
Index: trunk/src/org/openstreetmap/josm/data/coor/Coordinate.java
===================================================================
--- trunk/src/org/openstreetmap/josm/data/coor/Coordinate.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/data/coor/Coordinate.java (revision 655)
@@ -5,5 +5,5 @@
/**
- * Base class of points of both coordinate system.
+ * Base class of points of both coordinate systems.
*
* The variables are default package protected to allow routines in the data package
@@ -30,6 +30,6 @@
* The x/y values are left uninitialized.
*
- * @param lat Latitude of the point.
- * @param lon Longitude of the point.
+ * @param x X coordinate of the point.
+ * @param y Y coordinate of the point.
*/
Coordinate(double x, double y) {
Index: trunk/src/org/openstreetmap/josm/data/coor/EastNorth.java
===================================================================
--- trunk/src/org/openstreetmap/josm/data/coor/EastNorth.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/data/coor/EastNorth.java (revision 655)
@@ -3,5 +3,5 @@
/**
- * Northern, Easting of the projected coordinates.
+ * Northing, Easting of the projected coordinates.
*
* This class is immutable.
Index: trunk/src/org/openstreetmap/josm/data/coor/LatLon.java
===================================================================
--- trunk/src/org/openstreetmap/josm/data/coor/LatLon.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/data/coor/LatLon.java (revision 655)
@@ -28,6 +28,7 @@
/**
- * @return true, if the other point has almost the same lat/lon
- * values, only differ by no more than 1/Projection.MAX_SERVER_PRECISION.
+ * @return true if the other point has almost the same lat/lon
+ * values, only differing by no more than
+ * 1 / {@link org.openstreetmap.josm.data.projection.Projection#MAX_SERVER_PRECISION MAX_SERVER_PRECISION}.
*/
public boolean equalsEpsilon(LatLon other) {
Index: trunk/src/org/openstreetmap/josm/data/gpx/GpxData.java
===================================================================
--- trunk/src/org/openstreetmap/josm/data/gpx/GpxData.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/data/gpx/GpxData.java (revision 655)
@@ -12,6 +12,7 @@
/**
- * objects of this class represent a gpx file with tracks, waypoints and routes
- * it uses GPX1.1 see http://www.topografix.com/GPX/1/1/ for details
+ * Objects of this class represent a gpx file with tracks, waypoints and routes.
+ * It uses GPX v1.1, see {@link the spec}
+ * for details.
*
* @author Raphael Mack
Index: trunk/src/org/openstreetmap/josm/data/gpx/WayPoint.java
===================================================================
--- trunk/src/org/openstreetmap/josm/data/gpx/WayPoint.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/data/gpx/WayPoint.java (revision 655)
@@ -33,6 +33,5 @@
/**
- * convert the time stamp of ther waypoint into seconds from the epoch
- * @return seconds
+ * Convert the time stamp of the waypoint into seconds from the epoch
*/
public void setTime () {
Index: trunk/src/org/openstreetmap/josm/data/osm/Changeset.java
===================================================================
--- trunk/src/org/openstreetmap/josm/data/osm/Changeset.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/data/osm/Changeset.java (revision 655)
@@ -28,5 +28,5 @@
/**
- * User that created thos changeset, as specified by the server.
+ * User that created this changeset, as specified by the server.
* Never changed by JOSM.
*/
Index: trunk/src/org/openstreetmap/josm/data/osm/DataSet.java
===================================================================
--- trunk/src/org/openstreetmap/josm/data/osm/DataSet.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/data/osm/DataSet.java (revision 655)
@@ -16,5 +16,5 @@
* saved, (up/down/disk)loaded etc.
*
- * Note, that DataSet is not an osm-primitive and so has no key association
+ * Note that DataSet is not an osm-primitive and so has no key association
* but a few members to store some information.
*
@@ -49,6 +49,6 @@
/**
* A list of listeners to selection changed events. The list is static,
- * as listeners register themself for any dataset selection changes that
- * occour, regardless of the current active dataset. (However, the
+ * as listeners register themselves for any dataset selection changes that
+ * occur, regardless of the current active dataset. (However, the
* selection does only change in the active layer)
*/
@@ -91,5 +91,6 @@
/**
* Remove the selection of the whole dataset.
- * @deprecated Use setSelected() instead.
+ * @deprecated Use {@link #setSelected(Collection) setSelected}
+ * instead.
*/
@Deprecated
Index: trunk/src/org/openstreetmap/josm/data/osm/OsmPrimitive.java
===================================================================
--- trunk/src/org/openstreetmap/josm/data/osm/OsmPrimitive.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/data/osm/OsmPrimitive.java (revision 655)
@@ -22,6 +22,5 @@
*
* Although OsmPrimitive is designed as a base class, it is not to be meant to subclass
- * it by any other than from the package org.openstreetmap.josm.data.osm (thus the
- * visibility of the constructor). The available primitives are a fixed set that are given
+ * it by any other than from the package {@link org.openstreetmap.josm.data.osm}. The available primitives are a fixed set that are given
* by the server environment and not an extendible data stuff.
*
@@ -36,5 +35,5 @@
/**
- * Unique identifier in OSM. This is used to reidentify objects in the server.
+ * Unique identifier in OSM. This is used to identify objects on the server.
* An id of 0 means an unknown id. The object has not been uploaded yet to
* know what id it will get.
@@ -48,5 +47,5 @@
/**
- * true, if the object has been modified since it was loaded from
+ * true if the object has been modified since it was loaded from
* the server. In this case, on next upload, this object will be updated.
* Deleted objects are deleted from the server. If the objects are added (id=0),
@@ -83,5 +82,5 @@
/**
- * true if this object has direction dependant tags (e.g. oneway)
+ * true if this object has direction dependent tags (e.g. oneway)
*/
public boolean hasDirectionKeys = false;
@@ -113,5 +112,5 @@
/**
* Contains the version number as returned by the API. Needed to
- * ensure update consistancy
+ * ensure update consistency
*/
public int version = -1;
@@ -125,5 +124,5 @@
/**
- * Contains a list of direction-dependent keys that do not make an object
+ * Contains a list of direction-dependent keys that make an object
* direction dependent.
*/
@@ -132,5 +131,5 @@
/**
- * Implementation of the visitor scheme. Subclases have to call the correct
+ * Implementation of the visitor scheme. Subclasses have to call the correct
* visitor function.
* @param visitor The visitor from which the visit() function must be called.
@@ -174,7 +173,7 @@
/**
- * Return the id plus the class type encoded as hashcode or supers hashcode if id is 0.
+ * Return the id plus the class type encoded as hashcode or super's hashcode if id is 0.
*
- * An primitive has the same hashcode as its incomplete counter part.
+ * An primitive has the same hashcode as its incomplete counterpart.
*/
@Override public final int hashCode() {
Index: trunk/src/org/openstreetmap/josm/data/osm/User.java
===================================================================
--- trunk/src/org/openstreetmap/josm/data/osm/User.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/data/osm/User.java (revision 655)
@@ -7,5 +7,5 @@
* A simple class to keep a list of user names.
*
- * Instead of storing user names as strings with every OSM primtive, we store
+ * Instead of storing user names as strings with every OSM primitive, we store
* a reference to an user object, and make sure that for each username there
* is only one user object.
Index: trunk/src/org/openstreetmap/josm/data/osm/visitor/AddVisitor.java
===================================================================
--- trunk/src/org/openstreetmap/josm/data/osm/visitor/AddVisitor.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/data/osm/visitor/AddVisitor.java (revision 655)
@@ -8,5 +8,5 @@
/**
- * Visitor, that adds the visited object to the dataset given at constructor.
+ * Visitor that adds the visited object to the dataset given at constructor.
*
* Is not capable of adding keys.
Index: trunk/src/org/openstreetmap/josm/data/osm/visitor/BoundingXYVisitor.java
===================================================================
--- trunk/src/org/openstreetmap/josm/data/osm/visitor/BoundingXYVisitor.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/data/osm/visitor/BoundingXYVisitor.java (revision 655)
@@ -10,5 +10,5 @@
/**
- * Calculates the total bounding rectangle of a serie of OsmPrimitives, using the
+ * Calculates the total bounding rectangle of a series of OsmPrimitives, using the
* EastNorth values as reference.
* @author imi
Index: trunk/src/org/openstreetmap/josm/data/osm/visitor/DeleteVisitor.java
===================================================================
--- trunk/src/org/openstreetmap/josm/data/osm/visitor/DeleteVisitor.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/data/osm/visitor/DeleteVisitor.java (revision 655)
@@ -8,5 +8,5 @@
/**
- * Visitor, that adds the visited object to the dataset given at constructor.
+ * Visitor that adds the visited object to the dataset given at constructor.
*
* Is not capable of adding keys.
Index: trunk/src/org/openstreetmap/josm/data/projection/Projection.java
===================================================================
--- trunk/src/org/openstreetmap/josm/data/projection/Projection.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/data/projection/Projection.java (revision 655)
@@ -6,6 +6,6 @@
/**
- * Classes subclass this are able to convert lat/lon values to
- * planear screen coordinates.
+ * Classes implementing this are able to convert lat/lon values to
+ * planar screen coordinates.
*
* @author imi
@@ -13,10 +13,21 @@
public interface Projection {
+ /**
+ * Maximum latitude representable.
+ */
public static final double MAX_LAT = 85.05112877980659; // Mercator squares the world
+
+ /**
+ * Maximum longditude representable.
+ */
public static final double MAX_LON = 180;
+
+ /**
+ * Minimum difference in location to not be represented as the same position.
+ */
public static final double MAX_SERVER_PRECISION = 1e12;
/**
- * List of all available Projections.
+ * List of all available projections.
*/
public static Projection[] allProjections = new Projection[]{
Index: trunk/src/org/openstreetmap/josm/gui/MainApplication.java
===================================================================
--- trunk/src/org/openstreetmap/josm/gui/MainApplication.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/gui/MainApplication.java (revision 655)
@@ -58,5 +58,5 @@
// (By the eager loaded plugins)
//
- // These strings cannot be translated. That's live. Really. Sorry.
+ // These strings cannot be translated. That's life. Really. Sorry.
//
// Imi.
@@ -83,5 +83,4 @@
// get the preferences.
final File prefDir = new File(Main.pref.getPreferencesDir());
-
// check if preferences directory has moved (TODO: Update code. Remove this after some time)
File oldPrefDir = new File(System.getProperty("user.home")+"/.josm");
Index: trunk/src/org/openstreetmap/josm/gui/MapStatus.java
===================================================================
--- trunk/src/org/openstreetmap/josm/gui/MapStatus.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/gui/MapStatus.java (revision 655)
@@ -111,5 +111,5 @@
Collection osmStatus;
/**
- * The old modifiers, that was pressed the last time this collector ran.
+ * The old modifiers that was pressed the last time this collector ran.
*/
private int oldModifiers;
@@ -251,5 +251,5 @@
/**
* Construct a new MapStatus and attach it to the map view.
- * @param mv The MapView the status line is part of.
+ * @param mapFrame The MapFrame the status line is part of.
*/
public MapStatus(final MapFrame mapFrame) {
Index: trunk/src/org/openstreetmap/josm/gui/NavigatableComponent.java
===================================================================
--- trunk/src/org/openstreetmap/josm/gui/NavigatableComponent.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/gui/NavigatableComponent.java (revision 655)
@@ -105,5 +105,5 @@
/**
* Return the point on the screen where this Coordinate would be.
- * @param point The point, where this geopoint would be drawn.
+ * @param p The point, where this geopoint would be drawn.
* @return The point on screen where "point" would be drawn, relative
* to the own top/left.
@@ -117,6 +117,5 @@
/**
* Zoom to the given coordinate.
- * @param centerX The center x-value (easting) to zoom to.
- * @param centerY The center y-value (northing) to zoom to.
+ * @param newCenter The center x-value (easting) to zoom to.
* @param scale The scale to use.
*/
@@ -235,5 +234,5 @@
*
* @param p The point on screen.
- * @return The primitive, that is nearest to the point p.
+ * @return The primitive that is nearest to the point p.
*/
public OsmPrimitive getNearest(Point p) {
Index: trunk/src/org/openstreetmap/josm/gui/SelectionManager.java
===================================================================
--- trunk/src/org/openstreetmap/josm/gui/SelectionManager.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/gui/SelectionManager.java (revision 655)
@@ -62,5 +62,5 @@
/**
* Called, when the left mouse button was released.
- * @param r The rectangle, that is currently the selection.
+ * @param r The rectangle that is currently the selection.
* @param alt Whether the alt key was pressed
* @param shift Whether the shift key was pressed
@@ -107,5 +107,5 @@
* Create a new SelectionManager.
*
- * @param actionListener The action listener that receives the event when
+ * @param selectionEndedListener The action listener that receives the event when
* the left button is released.
* @param aspectRatio If true, the selection window must obtain the aspect
Index: trunk/src/org/openstreetmap/josm/gui/dialogs/PropertiesDialog.java
===================================================================
--- trunk/src/org/openstreetmap/josm/gui/dialogs/PropertiesDialog.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/gui/dialogs/PropertiesDialog.java (revision 655)
@@ -242,5 +242,4 @@
/**
- * @param row
* @param key
* @param allData
Index: trunk/src/org/openstreetmap/josm/gui/layer/Layer.java
===================================================================
--- trunk/src/org/openstreetmap/josm/gui/layer/Layer.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/gui/layer/Layer.java (revision 655)
@@ -98,10 +98,5 @@
*/
abstract public boolean isMergable(Layer other);
-
- /**
- * @return The bounding rectangle this layer occupies on screen when looking
- * at x/y values or null, if infinite area or unknown
- * area is occupied.
- */
+
abstract public void visitBoundingBox(BoundingXYVisitor v);
Index: trunk/src/org/openstreetmap/josm/gui/layer/OsmDataLayer.java
===================================================================
--- trunk/src/org/openstreetmap/josm/gui/layer/OsmDataLayer.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/gui/layer/OsmDataLayer.java (revision 655)
@@ -224,5 +224,5 @@
* after a successfull upload.
*
- * @param processed A list of all objects, that were actually uploaded.
+ * @param processed A list of all objects that were actually uploaded.
* May be null, which means nothing has been uploaded but
* saved to disk instead. Note that an empty collection for "processed"
Index: trunk/src/org/openstreetmap/josm/gui/layer/markerlayer/Marker.java
===================================================================
--- trunk/src/org/openstreetmap/josm/gui/layer/markerlayer/Marker.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/gui/layer/markerlayer/Marker.java (revision 655)
@@ -177,6 +177,5 @@
* created from the parameters given.
*
- * @param ll lat/lon for marker
- * @param data hash containing keys and values from the GPX waypoint structure
+ * @param wpt waypoint data for marker
* @param relativePath An path to use for constructing relative URLs or
* null for no relative URLs
Index: trunk/src/org/openstreetmap/josm/gui/layer/markerlayer/MarkerProducers.java
===================================================================
--- trunk/src/org/openstreetmap/josm/gui/layer/markerlayer/MarkerProducers.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/gui/layer/markerlayer/MarkerProducers.java (revision 655)
@@ -19,6 +19,5 @@
* given input data, or null otherwise.
*
- * @param ll lat/lon for the marker position
- * @param data A map of all tags found in the node of the gpx file.
+ * @param wp waypoint data
* @param relativePath An path to use for constructing relative URLs or
* null for no relative URLs
Index: trunk/src/org/openstreetmap/josm/io/MyHttpHandler.java
===================================================================
--- trunk/src/org/openstreetmap/josm/io/MyHttpHandler.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/io/MyHttpHandler.java (revision 655)
@@ -23,5 +23,5 @@
}
public MyHttpHandler(String proxy, int port) {
- proxy = proxy;
+ this.proxy = proxy;
proxyPort = port;
}
Index: trunk/src/org/openstreetmap/josm/io/OsmServerObjectReader.java
===================================================================
--- trunk/src/org/openstreetmap/josm/io/OsmServerObjectReader.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/io/OsmServerObjectReader.java (revision 655)
@@ -18,13 +18,13 @@
/**
- * Method to download single Objects from OSM server. ways, relations, nodes
- * @param id Object ID
- * @param type way node relation
+ * Method to download single objects from OSM server. ways, relations, nodes
+ * @param id Object ID
+ * @param type way node relation
* @param full download with or without child objects
- * @return
+ * @return the data requested
* @throws SAXException
* @throws IOException
*/
- public DataSet parseOsm(long id,String type, boolean full ) throws SAXException, IOException {
+ public DataSet parseOsm(long id, String type, boolean full) throws SAXException, IOException {
try {
Index: trunk/src/org/openstreetmap/josm/io/OsmServerReader.java
===================================================================
--- trunk/src/org/openstreetmap/josm/io/OsmServerReader.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/io/OsmServerReader.java (revision 655)
@@ -26,5 +26,6 @@
* 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 url The exact url to connect to.
+ * @param urlStr The exact url to connect to.
+ * @param pleaseWaitDlg
* @return An reader reading the input stream (servers answer) or null.
*/
Index: trunk/src/org/openstreetmap/josm/tools/AudioPlayer.java
===================================================================
--- trunk/src/org/openstreetmap/josm/tools/AudioPlayer.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/tools/AudioPlayer.java (revision 655)
@@ -140,5 +140,5 @@
/**
* To get the Url of the playing or recently played audio.
- * @returns url - could be null
+ * @return url - could be null
*/
public static URL url() {
@@ -148,5 +148,5 @@
/**
* Whether or not we are paused.
- * @returns boolean whether or not paused
+ * @return boolean whether or not paused
*/
public static boolean paused() {
@@ -156,5 +156,5 @@
/**
* Whether or not we are playing.
- * @returns boolean whether or not playing
+ * @return boolean whether or not playing
*/
public static boolean playing() {
@@ -164,5 +164,5 @@
/**
* How far we are through playing, in seconds.
- * @returns double seconds
+ * @return double seconds
*/
public static double position() {
@@ -172,5 +172,5 @@
/**
* Speed at which we will play.
- * @returns double, speed multiplier
+ * @return double, speed multiplier
*/
public static double speed() {
Index: trunk/src/org/openstreetmap/josm/tools/BugReportExceptionHandler.java
===================================================================
--- trunk/src/org/openstreetmap/josm/tools/BugReportExceptionHandler.java (revision 654)
+++ trunk/src/org/openstreetmap/josm/tools/BugReportExceptionHandler.java (revision 655)
@@ -33,5 +33,5 @@
/**
- * An exception handler, that ask the user to send a bug report.
+ * An exception handler that asks the user to send a bug report.
*
* @author imi
@@ -60,5 +60,5 @@
int answer = JOptionPane.showConfirmDialog(
Main.parent,
- tr("An unexpected exception occurred, that may come from in the ''{0}'' plugin.", plugin.info.name)+"\n"+
+ tr("An unexpected exception occurred that may have come from the ''{0}'' plugin.", plugin.info.name)+"\n"+
(plugin.info.author != null ? tr("According to the information within the plugin, the author is {0}.", plugin.info.author) : "")+"\n"+
tr("Should the plugin be disabled?"),