Changeset 8795 in josm


Ignore:
Timestamp:
2015-09-24T23:56:05+02:00 (3 years ago)
Author:
Don-vip
Message:

fix javadoc errors/warnings seen with JDK9

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

Legend:

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

    r8513 r8795  
    110110     *
    111111     * Case 1: One unclosed way.
    112      * --> allow action, and align selected way nodes
     112     * --> allow action, and align selected way nodes
    113113     * If nodes contained by this way are selected, there are fix.
    114114     * If nodes outside from the way are selected there are ignored.
    115115     *
    116116     * Case 2: One or more ways are selected and can be joined into a polygon
    117      * --> allow action, and align selected ways nodes
     117     * --> allow action, and align selected ways nodes
    118118     * If 1 node outside of way is selected, it became center
    119119     * If 1 node outside and 1 node inside are selected there define center and radius
     
    124124     *
    125125     * Case 3: Only nodes are selected
    126      * --> Align these nodes, all are fix
     126     * --> Align these nodes, all are fix
    127127     */
    128128    @Override
  • trunk/src/org/openstreetmap/josm/actions/CreateMultipolygonAction.java

    r8540 r8795  
    190190    /**
    191191     * Returns a {@link Pair} of the old multipolygon {@link Relation} (or null) and the newly created/modified multipolygon {@link Relation}.
     192     * @param selectedWays selected ways
     193     * @param selectedMultipolygonRelation selected multipolygon relation
     194     * @return pair of old and new multipolygon relation
    192195     */
    193196    public static Pair<Relation, Relation> updateMultipolygonRelation(Collection<Way> selectedWays, Relation selectedMultipolygonRelation) {
     
    207210    /**
    208211     * Returns a {@link Pair} null and the newly created/modified multipolygon {@link Relation}.
     212     * @param selectedWays selected ways
     213     * @param showNotif if {@code true}, shows a notification if an error occurs
     214     * @return pair of null and new multipolygon relation
    209215     */
    210216    public static Pair<Relation, Relation> createMultipolygonRelation(Collection<Way> selectedWays, boolean showNotif) {
     
    220226    /**
    221227     * Returns a {@link Pair} of a multipolygon creating/modifying {@link Command} as well as the multipolygon {@link Relation}.
     228     * @param selectedWays selected ways
     229     * @param selectedMultipolygonRelation selected multipolygon relation
     230     * @return pair of command and multipolygon relation
    222231     */
    223232    public static Pair<SequenceCommand, Relation> createMultipolygonCommand(Collection<Way> selectedWays,
     
    274283     * This method analyzes ways and creates multipolygon.
    275284     * @param selectedWays list of selected ways
     285     * @param showNotif if {@code true}, shows a notification if an error occurs
    276286     * @return <code>null</code>, if there was a problem with the ways.
    277287     */
     
    301311     * Builds a relation from polygon ways.
    302312     * @param pol data storage class containing polygon information
     313     * @param clone relation to clone, can be null
    303314     * @return multipolygon relation
    304315     */
  • trunk/src/org/openstreetmap/josm/actions/DistributeAction.java

    r8510 r8795  
    210210     * that are furthest apart, and then to distribute all other selected
    211211     * nodes along the straight line between these nodes.
     212     * @param nodes nodes to distribute
    212213     * @return Commands to execute to perform action
    213214     */
    214     private Collection<Command> distributeNodes(Collection<Node> nodes) {
     215    private static Collection<Command> distributeNodes(Collection<Node> nodes) {
    215216        // Find from the selected nodes two that are the furthest apart.
    216217        // Let's call them A and B.
  • trunk/src/org/openstreetmap/josm/actions/JoinAreasAction.java

    r8513 r8795  
    528528     * @param areas list of areas to join
    529529     * @return new area formed.
     530     * @throws UserCancelException if user cancels the operation
    530531     */
    531532    private JoinAreasResult joinAreas(List<Multipolygon> areas) throws UserCancelException {
     
    11941195     * @param polygon The list of outer ways that belong to that multigon.
    11951196     * @return The newly created outer way
     1197     * @throws UserCancelException if user cancels the operation
    11961198     */
    11971199    private Multipolygon  joinPolygon(AssembledMultipolygon polygon) throws UserCancelException {
     
    12091211     * @param ways The list of outer ways that belong to that multigon.
    12101212     * @return The newly created outer way
     1213     * @throws UserCancelException if user cancels the operation
    12111214     */
    12121215    private Way joinWays(List<WayInPolygon> ways) throws UserCancelException {
     
    12371240     * @param ways The list of ways to join and reverse
    12381241     * @return The newly created way
     1242     * @throws UserCancelException if user cancels the operation
    12391243     */
    12401244    private Way joinOrientedWays(List<WayInPolygon> ways) throws UserCancelException {
  • trunk/src/org/openstreetmap/josm/actions/ToggleAction.java

    r8540 r8795  
    120120     * the component already set the selected state.
    121121     * This method needs to be called especially if the action is associated with a keyboard shortcut to ensure correct selected state.
     122     * @param e ActionEvent that trigerred the action
    122123     * @see <a href="https://weblogs.java.net/blog/zixle/archive/2005/11/changes_to_acti.html">Changes to Actions in 1.6</a>
    123124     * @see <a href="http://docs.oracle.com/javase/6/docs/api/javax/swing/Action.html">Interface Action</a>
  • trunk/src/org/openstreetmap/josm/data/cache/ICachedLoaderJob.java

    r8673 r8795  
    4343     *
    4444     * @param listener cache loader listener
    45      * @param force true if the load should skip all the caches (local & remote)
     45     * @param force true if the load should skip all the caches (local &amp; remote)
    4646     * @throws IOException on failure from getUrl() call
    4747     */
  • trunk/src/org/openstreetmap/josm/data/gpx/GpxConstants.java

    r8512 r8795  
    5353    String PT_TIME = "time";
    5454
    55     /** Magnetic variation (in degrees) at the point. 0.0 <= value < 360.0 */
     55    /** Magnetic variation (in degrees) at the point. 0.0 &lt;= value &lt; 360.0 */
    5656    String PT_MAGVAR = "magvar";
    5757
     
    8383    String PT_AGEOFDGPSDATA = "ageofdgpsdata";
    8484
    85     /** Represents a differential GPS station. 0 <= value <= 1023 */
     85    /** Represents a differential GPS station. 0 &lt;= value &lt;= 1023 */
    8686    String PT_DGPSID = "dgpsid";
    8787
  • trunk/src/org/openstreetmap/josm/data/projection/Ellipsoid.java

    r8510 r8795  
    2525
    2626    /**
    27      * Australian National Spheroid (Australian Natl & S. Amer. 1969)
     27     * Australian National Spheroid (Australian Natl &amp; S. Amer. 1969)
    2828     * same as GRS67 Modified
    2929     */
  • trunk/src/org/openstreetmap/josm/data/validation/routines/RegexValidator.java

    r8510 r8795  
    3434 * <p>
    3535 * <ul>
    36  *   <li>Validate <code>true</code> or <code>false</code>:</li>
     36 *   <li>Validate <code>true</code> or <code>false</code>:
    3737 *   <ul>
    3838 *     <li><code>boolean valid = validator.isValid(value);</code></li>
    39  *   </ul>
    40  *   <li>Validate returning an aggregated String of the matched groups:</li>
     39 *   </ul></li>
     40 *   <li>Validate returning an aggregated String of the matched groups:
    4141 *   <ul>
    4242 *     <li><code>String result = validator.validate(value);</code></li>
    43  *   </ul>
    44  *   <li>Validate returning the matched groups:</li>
     43 *   </ul></li>
     44 *   <li>Validate returning the matched groups:
    4545 *   <ul>
    4646 *     <li><code>String[] result = validator.match(value);</code></li>
    47  *   </ul>
     47 *   </ul></li>
    4848 * </ul>
    4949 * <p>
  • trunk/src/org/openstreetmap/josm/data/validation/routines/UrlValidator.java

    r8510 r8795  
    2828/**
    2929 * <p><b>URL Validation</b> routines.</p>
    30  * Behavior of validation is modified by passing in options:
     30 * Behavior of validation is modified by passing in options:<ul>
    3131 * <li>ALLOW_2_SLASHES - [FALSE]  Allows double '/' characters in the path
    3232 * component.</li>
     
    3535 * <li>ALLOW_ALL_SCHEMES - [FALSE] By default only http, https, and ftp are
    3636 * considered valid schemes.  Enabling this option will let any scheme pass validation.</li>
    37  *
     37 * </ul>
    3838 * <p>Originally based in on php script by Debbie Dyer, validation.php v1.2b, Date: 03/07/02,
    3939 * http://javascript.internet.com. However, this validation now bears little resemblance
  • trunk/src/org/openstreetmap/josm/gui/PleaseWaitRunnable.java

    r8736 r8795  
    177177     * exception is thrown, a message box will be displayed and closeDialog
    178178     * is called. finish() is called in any case.
     179     * @throws SAXException if a SAX error occurs
     180     * @throws IOException if an I/O error occurs
     181     * @throws OsmTransferException if a communication error with the OSM server occurs
    179182     */
    180183    protected abstract void realRun() throws SAXException, IOException, OsmTransferException;
  • trunk/src/org/openstreetmap/josm/gui/mappaint/mapcss/ExpressionFactory.java

    r8775 r8795  
    565565
    566566        /**
    567          * Function associated to the logical ">=" operator.
     567         * Function associated to the logical "&gt;=" operator.
    568568         * @param a first value
    569569         * @param b second value
    570          * @return {@code true} if {@code a >= b}
     570         * @return {@code true} if {@code a &gt;= b}
    571571         */
    572572        public static boolean greater_equal(float a, float b) {
     
    575575
    576576        /**
    577          * Function associated to the logical "<=" operator.
     577         * Function associated to the logical "&lt;=" operator.
    578578         * @param a first value
    579579         * @param b second value
    580          * @return {@code true} if {@code a <= b}
     580         * @return {@code true} if {@code a &lt;= b}
    581581         */
    582582        public static boolean less_equal(float a, float b) {
     
    585585
    586586        /**
    587          * Function associated to the logical ">" operator.
     587         * Function associated to the logical "&gt;" operator.
    588588         * @param a first value
    589589         * @param b second value
    590          * @return {@code true} if {@code a > b}
     590         * @return {@code true} if {@code a &gt; b}
    591591         */
    592592        public static boolean greater(float a, float b) {
     
    595595
    596596        /**
    597          * Function associated to the logical "<" operator.
     597         * Function associated to the logical "&lt;" operator.
    598598         * @param a first value
    599599         * @param b second value
    600          * @return {@code true} if {@code a < b}
     600         * @return {@code true} if {@code a &lt; b}
    601601         */
    602602        public static boolean less(float a, float b) {
  • trunk/src/org/openstreetmap/josm/gui/widgets/AbstractFileChooser.java

    r8440 r8795  
    179179     * Pops up an "Open File" file chooser dialog. Note that the
    180180     * text that appears in the approve button is determined by
    181      * the L&F.
     181     * the L&amp;F.
    182182     *
    183183     * @param    parent  the parent component of the dialog,
     
    199199     * Pops up a "Save File" file chooser dialog. Note that the
    200200     * text that appears in the approve button is determined by
    201      * the L&F.
     201     * the L&amp;F.
    202202     *
    203203     * @param    parent  the parent component of the dialog,
  • trunk/src/org/openstreetmap/josm/plugins/PluginHandler.java

    r8776 r8795  
    463463
    464464    /**
    465      * Alerts the user if a plugin required by another plugin is missing, and offer to download them & restart JOSM
     465     * Alerts the user if a plugin required by another plugin is missing, and offer to download them &amp; restart JOSM
    466466     *
    467467     * @param parent The parent Component used to display error popup
  • trunk/src/org/openstreetmap/josm/tools/Utils.java

    r8777 r8795  
    13161316
    13171317    /**
    1318      * Returns a pair containing the number of threads (n), and a thread pool (if n > 1) to perform
     1318     * Returns a pair containing the number of threads (n), and a thread pool (if n &gt; 1) to perform
    13191319     * multi-thread computation in the context of the given preference key.
    13201320     * @param pref The preference key
    13211321     * @param nameFormat see {@link #newThreadFactory(String, int)}
    13221322     * @param threadPriority see {@link #newThreadFactory(String, int)}
    1323      * @return a pair containing the number of threads (n), and a thread pool (if n > 1, null otherwise)
     1323     * @return a pair containing the number of threads (n), and a thread pool (if n &gt; 1, null otherwise)
    13241324     * @since 7423
    13251325     */
Note: See TracChangeset for help on using the changeset viewer.