Ticket #812: javadoc.patch

File javadoc.patch, 10.1 KB (added by bruce89, 18 years ago)

  • src/org/openstreetmap/josm/actions/AlignInCircleAction.java

     
    2121import org.openstreetmap.josm.data.osm.Way;
    2222
    2323/**
    24  * Aligns all selected nodes within a circle. (Usefull for roundabouts)
     24 * Aligns all selected nodes within a circle. (Useful for roundabouts)
    2525 *
    2626 * @author Matthew Newton
    2727 */

  • src/org/openstreetmap/josm/actions/mapmode/DeleteAction.java

     
    3232 *
    3333 * The user can click on an object, which get deleted if possible. When Ctrl is
    3434 * pressed when releasing the button, the objects and all its references are
    35  * deleted. The exact definition of "all its references" are in 
    36  * @see #deleteWithReferences(OsmPrimitive)
     35 * deleted. The exact definition of "all its references" are in
     36 * {@link #deleteWithReferences deleteWithReferences}.
    3737 *
    3838 * If the user did not press Ctrl and the object has any references, the user
    3939 * is informed and nothing is deleted.

  • src/org/openstreetmap/josm/tools/AudioPlayer.java

     
    139139       
    140140        /**
    141141         * To get the Url of the playing or recently played audio.
    142          * @returns url - could be null
     142         * @return url - could be null
    143143         */
    144144        public static URL url() {
    145145                return AudioPlayer.get().playingUrl;
    … …  
    147147       
    148148        /**
    149149         * Whether or not we are paused.
    150          * @returns boolean whether or not paused
     150         * @return boolean whether or not paused
    151151         */
    152152        public static boolean paused() {
    153153                return AudioPlayer.get().state == State.PAUSED;
    … …  
    155155
    156156        /**
    157157         * Whether or not we are playing.
    158          * @returns boolean whether or not playing
     158         * @return boolean whether or not playing
    159159         */
    160160        public static boolean playing() {
    161161                return AudioPlayer.get().state == State.PLAYING;
    … …  
    163163
    164164        /**
    165165         * How far we are through playing, in seconds.
    166          * @returns double seconds
     166         * @return double seconds
    167167         */
    168168        public static double position() {
    169169                return AudioPlayer.get().position;
    … …  
    171171       
    172172        /**
    173173         * Speed at which we will play.
    174          * @returns double, speed multiplier
     174         * @return double, speed multiplier
    175175         */
    176176        public static double speed() {
    177177                return AudioPlayer.get().speed;

  • src/org/openstreetmap/josm/gui/NavigatableComponent.java

     
    104104
    105105        /**
    106106         * Return the point on the screen where this Coordinate would be.
    107          * @param point The point, where this geopoint would be drawn.
     107         * @param p The point, where this geopoint would be drawn.
    108108         * @return The point on screen where "point" would be drawn, relative
    109109         *              to the own top/left.
    110110         */
    … …  
    116116
    117117        /**
    118118         * Zoom to the given coordinate.
    119          * @param centerX The center x-value (easting) to zoom to.
    120          * @param centerY The center y-value (northing) to zoom to.
     119         * @param newCenter The center x-value (easting) to zoom to.
    121120         * @param scale The scale to use.
    122121         */
    123122        public void zoomTo(EastNorth newCenter, double scale) {

  • src/org/openstreetmap/josm/gui/SelectionManager.java

     
    106106        /**
    107107         * Create a new SelectionManager.
    108108         *
    109          * @param actionListener The action listener that receives the event when
     109         * @param selectionEndedListener The action listener that receives the event when
    110110         *              the left button is released.
    111111         * @param aspectRatio If true, the selection window must obtain the aspect
    112112         *              ratio of the drawComponent.

  • src/org/openstreetmap/josm/gui/MapStatus.java

     
    250250
    251251        /**
    252252         * Construct a new MapStatus and attach it to the map view.
    253          * @param mv The MapView the status line is part of.
     253         * @param mapFrame The MapFrame the status line is part of.
    254254         */
    255255        public MapStatus(final MapFrame mapFrame) {
    256256                this.mv = mapFrame.mapView;

  • src/org/openstreetmap/josm/gui/layer/Layer.java

     
    9797         * @return Whether the other layer can be merged into this layer.
    9898         */
    9999        abstract public boolean isMergable(Layer other);
    100        
    101         /**
    102          * @return The bounding rectangle this layer occupies on screen when looking
    103          *              at x/y values or <code>null</code>, if infinite area or unknown
    104          *              area is occupied.
    105          */
     100
    106101        abstract public void visitBoundingBox(BoundingXYVisitor v);
    107102
    108103        abstract public Object getInfoComponent();

  • src/org/openstreetmap/josm/gui/layer/markerlayer/Marker.java

     
    176176         * Returns an object of class Marker or one of its subclasses
    177177         * created from the parameters given.
    178178         *
    179          * @param ll lat/lon for marker
    180          * @param data hash containing keys and values from the GPX waypoint structure
     179         * @param wpt waypoint data for marker
    181180         * @param relativePath An path to use for constructing relative URLs or
    182181         *        <code>null</code> for no relative URLs
    183182         * @param offset double in seconds as the time offset of this marker from

  • src/org/openstreetmap/josm/gui/layer/markerlayer/MarkerProducers.java

     
    1818         * Returns a Marker object if this implementation wants to create one for the
    1919         * given input data, or <code>null</code> otherwise.
    2020         *
    21          * @param ll lat/lon for the marker position
    22          * @param data A map of all tags found in the <wpt> node of the gpx file.
     21         * @param wp waypoint data
    2322         * @param relativePath An path to use for constructing relative URLs or
    2423         *        <code>null</code> for no relative URLs
    2524         * @return A Marker object, or <code>null</code>.

  • src/org/openstreetmap/josm/io/OsmServerObjectReader.java

     
    1717     public final static  String TYPE_NODE = "node";
    1818     
    1919     /**
    20       * Method to download single Objects from OSM server. ways, relations, nodes
    21       * @param id  Object ID
    22       * @param type  way node relation
     20      * Method to download single objects from OSM server. ways, relations, nodes
     21      * @param id Object ID
     22      * @param type way node relation
    2323      * @param full download with or without child objects
    24       * @return
     24      * @return the data requested
    2525      * @throws SAXException
    2626      * @throws IOException
    2727      */
    28      public DataSet parseOsm(long id,String type, boolean full ) throws SAXException, IOException {
     28     public DataSet parseOsm(long id, String type, boolean full) throws SAXException, IOException {
    2929            try {
    3030               
    3131                Main.pleaseWaitDlg.progress.setValue(0);

  • src/org/openstreetmap/josm/io/MyHttpHandler.java

     
    2222                return openConnection(u, (Proxy) null);
    2323            }
    2424            public MyHttpHandler(String proxy, int port) {
    25                 proxy = proxy;
     25                this.proxy = proxy;
    2626                proxyPort = port;
    2727            }
    2828 

  • src/org/openstreetmap/josm/data/projection/Projection.java

     
    55import org.openstreetmap.josm.data.coor.LatLon;
    66
    77/**
    8  * Classes subclass this are able to convert lat/lon values to
    9  * planear screen coordinates.
     8 * Classes implementing this are able to convert lat/lon values to
     9 * planar screen coordinates.
    1010 *
    1111 * @author imi
    1212 */
    … …  
    1717        public static final double MAX_SERVER_PRECISION = 1e12;
    1818
    1919        /**
    20          * List of all available Projections.
     20         * List of all available projections.
    2121         */
    2222        public static Projection[] allProjections = new Projection[]{
    2323                new Epsg4326(),

  • src/org/openstreetmap/josm/data/gpx/WayPoint.java

     
    3232        }
    3333       
    3434        /**
    35          * convert the time stamp of ther waypoint into seconds from the epoch
    36          * @return seconds
     35         * Convert the time stamp of the waypoint into seconds from the epoch
    3736         */
    3837        public void setTime () {
    3938                if (! attr.containsKey("time")) {