Changeset 8931 in josm


Ignore:
Timestamp:
2015-10-23T01:17:45+02:00 (5 years ago)
Author:
Don-vip
Message:

javadoc fixes

Location:
trunk/src/org/openstreetmap/josm
Files:
15 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/org/openstreetmap/josm/actions/JoinAreasAction.java

    r8926 r8931  
    259259
    260260        /**
    261          * Oriented angle (N1N2, N1N3) in range [0; 2*Math.PI[
     261         * Returns oriented angle (N1N2, N1N3) in range [0; 2*Math.PI[
     262         * @return oriented angle (N1N2, N1N3) in range [0; 2*Math.PI[
    262263         */
    263264        private static double getAngle(Node N1, Node N2, Node N3) {
     
    588589        // Find boundary ways
    589590        List<Way> discardedWays = new ArrayList<>();
    590         List<AssembledPolygon> bounadries = findBoundaryPolygons(preparedWays, discardedWays);
     591        List<AssembledPolygon> boundaries = findBoundaryPolygons(preparedWays, discardedWays);
    591592
    592593        //find polygons
    593         List<AssembledMultipolygon> preparedPolygons = findPolygons(bounadries);
    594 
     594        List<AssembledMultipolygon> preparedPolygons = findPolygons(boundaries);
    595595
    596596        //assemble final polygons
  • trunk/src/org/openstreetmap/josm/actions/OrthogonalizeAction.java

    r8926 r8931  
    199199    /**
    200200     * Collect groups of ways with common nodes in order to orthogonalize each group separately.
     201     * @return groups of ways with common nodes
    201202     */
    202203    private static List<List<WayData>> buildGroups(List<WayData> wayDataList) {
     
    245246     *      - The same for vertical segments.
    246247     *  5. Rotate back.
     248     * @return list of commands to perform
    247249     * @throws InvalidUserInputException if selected ways have an angle different from 90 or 180 degrees
    248250     **/
     
    475477    /**
    476478     * Make sure angle (up to 2*Pi) is in interval [ 0, 2*Pi ).
     479     * @return correct angle
    477480     */
    478481    private static double standard_angle_0_to_2PI(double a) {
     
    488491    /**
    489492     * Make sure angle (up to 2*Pi) is in interval ( -Pi, Pi ].
     493     * @return correct angle
    490494     */
    491495    private static double standard_angle_mPI_to_PI(double a) {
     
    509513        /**
    510514         * Rotate counter-clock-wise.
     515         * @return new east/north
    511516         */
    512517        public static EastNorth rotateCC(EastNorth pivot, EastNorth en, double angle) {
     
    535540    /**
    536541     * Recognize angle to be approximately 0, 90, 180 or 270 degrees.
    537      * returns an integral value, corresponding to a counter clockwise turn:
     542     * returns an integral value, corresponding to a counter clockwise turn.
     543     * @return an integral value, corresponding to a counter clockwise turn
    538544     * @throws RejectedAngleException in case of invalid angle
    539545     */
  • trunk/src/org/openstreetmap/josm/actions/PasteTagsAction.java

    r8855 r8931  
    6464
    6565        /**
    66          * Replies true if the source for tag pasting is heterogeneous, i.e. if it doesn't consist of
     66         * Determines if the source for tag pasting is heterogeneous, i.e. if it doesn't consist of
    6767         * {@link OsmPrimitive}s of exactly one type
     68         * @return true if the source for tag pasting is heterogeneous
    6869         */
    6970        protected boolean isHeteogeneousSource() {
  • trunk/src/org/openstreetmap/josm/actions/SplitWayAction.java

    r8902 r8931  
    6767        private final Command command;
    6868        private final List<? extends PrimitiveId> newSelection;
    69         private Way originalWay;
    70         private List<Way> newWays;
     69        private final Way originalWay;
     70        private final List<Way> newWays;
    7171
    7272        /**
  • trunk/src/org/openstreetmap/josm/actions/UnGlueAction.java

    r8870 r8931  
    225225     * The way will be put into the object variable "selectedWay", the
    226226     * node into "selectedNode".
     227     * @return true if either one node is selected or one node and one way are selected and the node is part of the way
    227228     */
    228229    private boolean checkSelection(Collection<? extends OsmPrimitive> selection) {
     
    260261     * The way will be put into the object variable "selectedWay", the
    261262     * nodes into "selectedNodes".
     263     * @return true if one way and any number of nodes that are part of that way are selected
    262264     */
    263265    private boolean checkSelection2(Collection<? extends OsmPrimitive> selection) {
     
    302304     * <li>the changed way will be returned and must be put into cmds by the caller!</li>
    303305     * </ul>
     306     * @return new way
    304307     */
    305308    private static Way modifyWay(Node originalNode, Way w, List<Command> cmds, List<Node> newNodes) {
  • trunk/src/org/openstreetmap/josm/actions/UploadAction.java

    r8510 r8931  
    163163
    164164    /**
    165      * returns true if the user wants to cancel, false if they
    166      * want to continue
     165     * Warn user about discouraged upload, propose to cancel operation.
     166     * @param layer incriminated layer
     167     * @return true if the user wants to cancel, false if they want to continue
    167168     */
    168169    public static boolean warnUploadDiscouraged(AbstractModifiableLayer layer) {
  • trunk/src/org/openstreetmap/josm/actions/mapmode/DrawAction.java

    r8870 r8931  
    155155
    156156    /**
    157      * Checks if a map redraw is required and does so if needed. Also updates the status bar
     157     * Checks if a map redraw is required and does so if needed. Also updates the status bar.
     158     * @return true if a repaint is needed
    158159     */
    159160    private boolean redrawIfRequired() {
     
    11031104    /**
    11041105     * Removes target highlighting from primitives. Issues repaint if required.
    1105      * Returns true if a repaint has been issued.
     1106     * @return true if a repaint has been issued.
    11061107     */
    11071108    private boolean removeHighlighting() {
     
    12351236     * to work around this issue.
    12361237     * Otherwise the normal selection of the current data layer is returned.
     1238     * @return selected primitives, while draw action is in progress
    12371239     */
    12381240    public Collection<OsmPrimitive> getInProgressSelection() {
  • trunk/src/org/openstreetmap/josm/actions/mapmode/ExtrudeAction.java

    r8870 r8931  
    11081108
    11091109    /**
    1110      * Returns true if from1-to1 and from2-to2 vertors directions are opposite
     1110     * Determines if from1-to1 and from2-to2 vertors directions are opposite
     1111     * @return true if from1-to1 and from2-to2 vertors directions are opposite
    11111112     */
    11121113    private static boolean isOppositeDirection(EastNorth from1, EastNorth to1, EastNorth from2, EastNorth to2) {
  • trunk/src/org/openstreetmap/josm/actions/mapmode/SelectAction.java

    r8870 r8931  
    686686    }
    687687
    688     /** returns true whenever elements have been grabbed and moved (i.e. the initial
    689      * thresholds have been exceeded) and is still in progress (i.e. mouse button
    690      * still pressed)
     688    /**
     689     * Determines whenever elements have been grabbed and moved (i.e. the initial
     690     * thresholds have been exceeded) and is still in progress (i.e. mouse button still pressed)
     691     * @return true if a drag is in progress
    691692     */
    692693    private boolean dragInProgress() {
     
    797798    /**
    798799     * Obtain command in undoRedo stack to "continue" when dragging
     800     * @return last command
    799801     */
    800802    private static Command getLastCommand() {
     
    901903     * Tries to find a node to merge to when in move-merge mode for the current mouse
    902904     * position. Either returns the node or null, if no suitable one is nearby.
     905     * @return node to merge to, or null
    903906     */
    904907    private Node findNodeToMergeTo(Point p) {
  • trunk/src/org/openstreetmap/josm/actions/search/SearchCompiler.java

    r8899 r8931  
    241241        /**
    242242         * Tests whether one of the primitives matches.
     243         * @param primitives primitives
     244         * @return {@code true} if one of the primitives matches, {@code false} otherwise
    243245         */
    244246        protected boolean existsMatch(Collection<? extends OsmPrimitive> primitives) {
     
    252254        /**
    253255         * Tests whether all primitives match.
     256         * @param primitives primitives
     257         * @return {@code true} if all primitives match, {@code false} otherwise
    254258         */
    255259        protected boolean forallMatch(Collection<? extends OsmPrimitive> primitives) {
  • trunk/src/org/openstreetmap/josm/actions/upload/UploadHook.java

    r8512 r8931  
    55
    66public interface UploadHook {
     7
    78    /**
    89     * Checks the upload.
    910     * @param apiDataSet the data to upload
     11     * @return {@code true} if upload is possible
    1012     */
    1113    boolean checkUpload(APIDataSet apiDataSet);
  • trunk/src/org/openstreetmap/josm/command/Command.java

    r8510 r8931  
    220220    /**
    221221     * Replies the layer this command is (or was) applied to.
    222      *
     222     * @return the layer this command is (or was) applied to
    223223     */
    224224    protected OsmDataLayer getLayer() {
     
    241241     * Return the primitives that take part in this command.
    242242     */
    243     @Override public Collection<? extends OsmPrimitive> getParticipatingPrimitives() {
     243    @Override
     244    public Collection<? extends OsmPrimitive> getParticipatingPrimitives() {
    244245        return cloneMap.keySet();
    245246    }
  • trunk/src/org/openstreetmap/josm/command/PurgeCommand.java

    r8510 r8931  
    142142     * Sorts a collection of primitives such that for each object
    143143     * its referrers come later in the sorted collection.
     144     * @return sorted list
    144145     */
    145146    public static List<OsmPrimitive> topoSort(Collection<OsmPrimitive> sel) {
  • trunk/src/org/openstreetmap/josm/command/RotateCommand.java

    r8840 r8931  
    4747
    4848    /**
    49      * Get angle between the horizontal axis and the line formed by the pivot and give points.
     49     * Get angle between the horizontal axis and the line formed by the pivot and given point.
     50     * @return angle between the horizontal axis and the line formed by the pivot and given point
    5051     **/
    5152    protected final double getAngle(EastNorth currentEN) {
  • trunk/src/org/openstreetmap/josm/command/TransformNodesCommand.java

    r8510 r8931  
    119119    /**
    120120     * Get the nodes with the current transformation applied.
     121     * @return nodes with the current transformation applied
    121122     */
    122123    public Collection<Node> getTransformedNodes() {
     
    127128     * Get the center of the nodes under modification.
    128129     * It's just the barycenter.
     130     * @return center east/north of the nodes under modification
    129131     * @see org.openstreetmap.josm.tools.Geometry#getCentroid(java.util.List)
    130132     */
Note: See TracChangeset for help on using the changeset viewer.