Changeset 19691 in josm


Ignore:
Timestamp:
2026-11-19T09:40:24+01:00 (less than one hour ago)
Author:
stoecker
Message:

fix javadoc

Location:
trunk
Files:
23 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/org/openstreetmap/josm/data/osm/event/DataSetListener.java

    r18792 r19691  
    6969     * {@link #dataChanged(DataChangedEvent)}.
    7070     * @param event The event to call the individual elements from
    71      * @implNote Implementors should decide what they want to do with {@code event == null},
     71     * Implementors should decide what they want to do with {@code event == null},
    7272     * {@code event.getEvents() == null}, and {@code event.getEvents().isEmpty()}.
    7373     * @since 18792
  • trunk/src/org/openstreetmap/josm/data/projection/proj/AbstractProj.java

    r18353 r19691  
    1414 * git 8cbf52d, org.geotools.referencing.operation.projection.MapProjection
    1515 * at the time of migration.
    16  * <p>
    17  *
    1816 * @author André Gosselin
    1917 * @author Martin Desruisseaux (PMO, IRD)
  • trunk/src/org/openstreetmap/josm/data/validation/routines/package.html

    r14273 r19691  
    2121<body bgcolor="white">
    2222    <p>This package contains <i>independent</i> validation routines adapted from Apache Commons Validator 1.5.0.</p>
    23 <h1>Table of Contents</h1>
     23<h2>Table of Contents</h2>
    2424
    2525<ul>
    … …  
    3737
    3838<a id="overview"></a>
    39 <h1>1. Overview</h1>
     39<h2>1. Overview</h2>
    4040<p>
    4141   Commons Validator serves two purposes:
    … …  
    5757
    5858<a id="other"></a>
    59 <h1>2. Validators</h1>
     59<h2>2. Validators</h2>
    6060
    6161<a id="other.overview"></a>
    62 <h2>2.1 Overview</h2>
     62<h3>2.1 Overview</h3>
    6363<p>
    6464   This section lists other available validators.
    … …  
    7878
    7979<a id="other.regex"></a>
    80 <h2>2.2 Regular Expression Validation</h2>
     80<h3>2.2 Regular Expression Validation</h3>
    8181<p>
    8282   Regular expression validation can be done either by using the <i>static</i>
    … …  
    159159
    160160<a id="other.inet"></a>
    161 <h2>2.3 IP Address Validation</h2>
     161<h3>2.3 IP Address Validation</h3>
    162162
    163163<p>
    … …  
    181181
    182182<a id="other.email"></a>
    183 <h2>2.4 Email Address Validation</h2>
     183<h3>2.4 Email Address Validation</h3>
    184184
    185185<p>
    … …  
    205205
    206206<a id="other.url"></a>
    207 <h2>2.5 URL Validation</h2>
     207<h3>2.5 URL Validation</h3>
    208208
    209209<p>
    … …  
    246246
    247247<a id="other.domain"></a>
    248 <h2>2.6 Domain Name Validation</h2>
     248<h3>2.6 Domain Name Validation</h3>
    249249
    250250<p>
  • trunk/src/org/openstreetmap/josm/data/validation/tests/PowerLines.java

    r19658 r19691  
    347347     * @param crossingWays found crossing ways
    348348     * @param crossingPositions collection of the crossing positions
    349      * @implNote Inspired by {@code utilsplugin2/selection/NodeWayUtils.java#addWaysIntersectingWay()}
     349     * Inspired by {@code utilsplugin2/selection/NodeWayUtils.java#addWaysIntersectingWay()}
    350350     */
    351351    private static void findCrossings(Map<Point2D, List<WaySegment>> ways, Way parent, Set<Way> crossingWays,
  • trunk/src/org/openstreetmap/josm/data/validation/util/AggregatePrimitivesVisitor.java

    r18960 r19691  
    1414/**
    1515 * A visitor that aggregates all primitives it visits.
    16  * <p>
    17  *
    1816 * @author frsantos
    1917 */
  • trunk/src/org/openstreetmap/josm/gui/MenuScroller.java

    r19050 r19691  
    3434 * popup menu. A number of items can optionally be frozen at the top of the menu.
    3535 * <p>
    36  * <b>Implementation note:</B>  The default scrolling interval is 150 milliseconds.
    37  * <p>
     36 * <b>Implementation note:</B> The default scrolling interval is 150 milliseconds.
    3837 * @author Darryl, https://tips4java.wordpress.com/2009/02/01/menu-scroller/
    3938 * @since 4593
  • trunk/src/org/openstreetmap/josm/gui/dialogs/relation/actions/IRelationEditorActionAccess.java

    r19519 r19691  
    1818/**
    1919 * This interface provides access to the relation editor for actions.
    20  * <p>
    21  *
    2220 * @author Michael Zangl
    2321 * @since 14027
  • trunk/src/org/openstreetmap/josm/gui/layer/AbstractTileSourceLayer.java

    r19640 r19691  
    267267    /**
    268268     * Get projections this imagery layer supports natively.
    269      * <p/>
     269     * <p>
    270270     * For example projection of tiles that are downloaded from a server. Layer may support even more
    271271     * projections (by reprojecting the tiles), but with a certain loss in image quality and performance.
    … …  
    679679     * @see #drawInViewArea(Graphics2D, MapView, ProjectionBounds)
    680680     * @see AbstractTileSourceLayer.TileSet#overloadTiles()
     681     * @param visibleTiles number of currently visible tiles
     682     * @param maxXtiles maximum number of tiles along the horizontal (X) axis
     683     * @param maxYtiles maximum number of tiles along the vertical (Y) axis
     684     * @return estimated total number of tiles to load across zoom levels and borders
    681685     */
    682686    private static int calculateRealTiles(int visibleTiles, int maxXtiles, int maxYtiles) {
  • trunk/src/org/openstreetmap/josm/gui/layer/LayerManager.java

    r19519 r19691  
    2222 * <p>
    2323 * This manager handles a list of layers with the first layer being the front layer.
    24  * <h1>Threading</h1>
     24 * <h2>Threading</h2>
    2525 * Synchronization of the layer manager is done by synchronizing all read/write access. All changes are internally done in the EDT thread.
    2626 * <p>
  • trunk/src/org/openstreetmap/josm/gui/layer/geoimage/GeoImageLayer.java

    r19584 r19691  
    988988     * @param exif also returns images with exif-gps info
    989989     * @param tagged also returns tagged images
    990      * @param gpsTime use GPS Time if true, instead of Camera RTC Time
     990     * @param timeSource allows to use GPS Time or Camera RTC Time
    991991     * @return matching images
    992992     * @since 19455 gpsTime was added
  • trunk/src/org/openstreetmap/josm/gui/preferences/projection/GaussKruegerProjectionChoice.java

    r16916 r19691  
    1111/**
    1212 * ProjectionChoice for Gauß-Krüger coordinate system (zones 2-5, EPSG:31466-31469).
    13  * <p>
    1413 * @see <a href="https://de.wikipedia.org/wiki/Gauß-Krüger-Koordinatensystem">Gauß-Krüger</a>
    1514 */
  • trunk/src/org/openstreetmap/josm/gui/preferences/projection/LambertCC9ZonesProjectionChoice.java

    r16916 r19691  
    1818/**
    1919 * ProjectionChoice for Lambert CC (9 zones, EPSG:3942-3950).
    20  * <p>
    2120 * @see <a href="https://fr.wikipedia.org/wiki/Projection_conique_conforme_de_Lambert#Lambert_zone_CC">Lambert CC</a>
    2221 */
  • trunk/src/org/openstreetmap/josm/gui/preferences/projection/LambertProjectionChoice.java

    r16438 r19691  
    1818/**
    1919 * ProjectionChoice for 4 zone Lambert (1920, EPSG:27561-27564).
    20  * <p>
    2120 * @see <a href="https://fr.wikipedia.org/wiki/Projection_conique_conforme_de_Lambert#Lambert_zone">Lambert zone</a>
    2221 */
  • trunk/src/org/openstreetmap/josm/gui/preferences/projection/PuwgProjectionChoice.java

    r16438 r19691  
    1313/**
    1414 * ProjectionChoice for PUWG 1992 (EPSG:2180) and PUWG 2000 for Poland (Zone 5-8, EPSG:2176-2179).
    15  * <p>
    1615 * @see <a href="https://pl.wikipedia.org/wiki/Uk%C5%82ad_wsp%C3%B3%C5%82rz%C4%99dnych_1992">PUWG 1992</a>
    1716 * @see <a href="https://pl.wikipedia.org/wiki/Uk%C5%82ad_wsp%C3%B3%C5%82rz%C4%99dnych_2000">PUWG 2000</a>
  • trunk/src/org/openstreetmap/josm/gui/preferences/projection/UTMFranceDOMProjectionChoice.java

    r16438 r19691  
    1212/**
    1313 * ProjectionChoice for various French overseas territories (EPSG:2969,2970,2972,2973,2975).
    14  * <p>
    1514 * @see <a href="https://fr.wikipedia.org/wiki/Système_de_coordonnées_(cartographie)#Dans_les_d.C3.A9partements_d.27Outre-mer">DOM</a>
    1615 */
  • trunk/src/org/openstreetmap/josm/gui/preferences/projection/UTMProjectionChoice.java

    r13206 r19691  
    2222/**
    2323 * ProjectionChoice for UTM.
    24  * <p>
    2524 * @see <a href="https://en.wikipedia.org/wiki/Universal_Transverse_Mercator_coordinate_system">UTM</a>
    2625 */
  • trunk/src/org/openstreetmap/josm/gui/tagging/presets/items/RegionSpecific.java

    r19519 r19691  
    2222     * Get the regions for the item
    2323     * @return The regions that the item is valid for
    24      * @apiNote This is not {@code getRegions} just in case we decide to make the {@link RegionSpecific} record classes.
     24     * This is not {@code getRegions} just in case we decide to make the {@link RegionSpecific} record classes.
    2525     */
    2626    Collection<String> regions();
    … …  
    5050    /**
    5151     * Get the exclude_regions for the preset
    52      * @apiNote This is not {@code getExclude_regions} just in case we decide to make {@link RegionSpecific} a record class.
     52     * This is not {@code getExclude_regions} just in case we decide to make {@link RegionSpecific} a record class.
    5353     * @return {@code true} if the meaning of {@link #regions()} should be inverted
    5454     */
  • trunk/src/org/openstreetmap/josm/io/ChangesetQuery.java

    r19103 r19691  
    2828 * Data class to collect restrictions (parameters) for downloading changesets from the
    2929 * OSM API.
    30  * <p>
    3130 * @see <a href="https://wiki.openstreetmap.org/wiki/API_v0.6#Query:_GET_.2Fapi.2F0.6.2Fchangesets">OSM API 0.6 call "/changesets?"</a>
    3231 */
  • trunk/src/org/openstreetmap/josm/io/DiffResultProcessor.java

    r19575 r19691  
    4141 * The goal is to have a clean state, just like a fresh download (assuming no
    4242 * concurrent uploads by other users have happened in the meantime).
    43  * <p>
    4443 * @see <a href="https://wiki.openstreetmap.org/wiki/API_v0.6#Response_10">API 0.6 diff upload response</a>
    4544 */
  • trunk/src/org/openstreetmap/josm/io/OsmPbfReader.java

    r19519 r19691  
    5353     * This could be replaced by {@link org.apache.commons.io.input.BoundedInputStream} from Apache Commons IO.
    5454     * However, Commons IO is not <i>currently</i> (2024-05-13) a required JOSM dependency, so we should avoid using it
    55      * for now. Commons IO is a <i>transitive</i> dependency, currently pulled in by {@link org.apache.commons.compress}
     55     * for now. Commons IO is a <i>transitive</i> dependency, currently pulled in by <code>org.apache.commons.compress</code>
    5656     * (see {@link org.apache.commons.compress.utils.BoundedInputStream}).
    5757     */
  • trunk/src/org/openstreetmap/josm/tools/XmlObjectParser.java

    r19050 r19691  
    206206        /**
    207207         * Get a field (uncached in {@link #fields})
    208          * @implNote Please profile startup when changing
     208         * Please profile startup when changing
    209209         * @param s The field to get
    210210         * @return The field, or {@code null}.
    … …  
    228228        /**
    229229         * Get an uncached method (in {@link #methods})
    230          * @implNote Please profile startup when changing
     230         * Please profile startup when changing
    231231         * @param s The method to find
    232232         * @return The method or {@code null}.
  • trunk/src/org/openstreetmap/josm/tools/bugreport/BugReport.java

    r19535 r19691  
    2020 * It also contains the main entry point for all components to use the bug report system: Call {@link #intercept(Throwable)} to start handling an
    2121 * exception.
    22  * <h1> Handling Exceptions </h1>
     22 * <h2> Handling Exceptions </h2>
    2323 * In your code, you should add try...catch blocks for any runtime exceptions that might happen. It is fine to catch throwable there.
    2424 * <p>
    … …  
    3939 * Instead of re-throwing, you can call {@link ReportedException#warn()}. This will display a warning to the user and allow it to either report
    4040 * the exception or ignore it.
    41  *
    4241 * @author Michael Zangl
    4342 * @since 10285
  • trunk/test/config/functional-josm.home

    • Property svn:ignore
      •  

        old new  
        44preferences.xml
        55validator
         6images
Note: See TracChangeset for help on using the changeset viewer.