Changeset 12259 in josm


Ignore:
Timestamp:
2017-05-26T01:12:46+02:00 (2 years ago)
Author:
bastiK
Message:

see #14794 - javadoc

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

Legend:

Unmodified
Added
Removed
  • trunk/src/org/openstreetmap/josm/gui/GettingStarted.java

    r11171 r12259  
    3333import org.openstreetmap.josm.tools.WikiReader;
    3434
     35/**
     36 * Panel that fills the main part of the program window when JOSM has just started.
     37 *
     38 * It downloads and displays the so called <em>message of the day</em>, which
     39 * contains news about recent major changes, warning in case of outdated versions, etc.
     40 */
    3541public final class GettingStarted extends JPanel implements ProxyPreferenceListener {
    3642
  • trunk/src/org/openstreetmap/josm/gui/mappaint/StyleKeys.java

    r11760 r12259  
    22package org.openstreetmap.josm.gui.mappaint;
    33
     4/**
     5 * Interface defining string constants (MapCSS property keys).
     6 *
     7 * For the implementation of the <code>@supports</code> feature, the list of
     8 * supported keys is loaded from this interface using reflection.
     9 * @see org.openstreetmap.josm.gui.mappaint.mapcss.MapCSSStyleSource#evalSupportsDeclCondition(java.lang.String, java.lang.Object)
     10 */
    411public interface StyleKeys {
    512
  • trunk/src/org/openstreetmap/josm/gui/mappaint/mapcss/CSSColors.java

    r10001 r12259  
    66import java.util.Map;
    77
     8/**
     9 * List of named CSS colors as per CSS Color Module Level 3.
     10 *
     11 * @see <a href="https://drafts.csswg.org/css-color-3/">CSS Color Module Level 3</a>
     12 */
    813public final class CSSColors {
    914    private static final Map<String, Color> CSS_COLORS = new HashMap<>();
  • trunk/src/org/openstreetmap/josm/gui/mappaint/mapcss/Instruction.java

    r10600 r12259  
    1111import org.openstreetmap.josm.gui.mappaint.StyleKeys;
    1212
     13/**
     14 * A MapCSS Instruction.
     15 *
     16 * For example a simple assignment like <code>width: 3;</code>, but may also
     17 * be a set instruction (<code>set highway;</code>).
     18 * A MapCSS {@link MapCSSRule.Declaration} is a list of instructions.
     19 */
    1320@FunctionalInterface
    1421public interface Instruction extends StyleKeys {
    1522
     23    /**
     24     * Execute the instruction in the given environment.
     25     * @param env the environment
     26     */
    1627    void execute(Environment env);
    1728
  • trunk/src/org/openstreetmap/josm/gui/mappaint/styleelement/RepeatImageElement.java

    r11809 r12259  
    1313import org.openstreetmap.josm.tools.CheckParameterUtil;
    1414
     15/**
     16 * Style element that displays a repeated image pattern along a way.
     17 */
    1518public class RepeatImageElement extends StyleElement {
    1619
  • trunk/src/org/openstreetmap/josm/gui/mappaint/styleelement/StyleElement.java

    r11452 r12259  
    1616import org.openstreetmap.josm.gui.mappaint.mapcss.Instruction.RelativeFloat;
    1717
     18/**
     19 * Class that defines how objects ({@link OsmPrimitive}) should be drawn on the map.
     20 *
     21 * Several subclasses of this abstract class implement different drawing features,
     22 * like icons for a node or area fill. This class and all its subclasses are immutable
     23 * and tend to get shared when multiple objects have the same style (in order to
     24 * save memory, see {@link org.openstreetmap.josm.gui.mappaint.StyleCache#intern()}).
     25 */
    1826public abstract class StyleElement implements StyleKeys {
    1927
     
    3240    public boolean defaultSelectedHandling;
    3341
     42    /**
     43     * Construct a new StyleElement
     44     * @param majorZindex like z-index, but higher priority
     45     * @param zIndex order the objects are drawn
     46     * @param objectZindex like z-index, but lower priority
     47     * @param isModifier if false, a default line or node symbol is generated
     48     * @param defaultSelectedHandling true if default behavior for selected objects
     49     * is enabled, false if a style for selected state is given explicitly
     50     */
    3451    public StyleElement(float majorZindex, float zIndex, float objectZindex, boolean isModifier, boolean defaultSelectedHandling) {
    3552        this.majorZIndex = majorZindex;
  • trunk/src/org/openstreetmap/josm/gui/progress/PleaseWaitProgressMonitor.java

    r11746 r12259  
    1818import org.openstreetmap.josm.tools.bugreport.BugReport;
    1919
     20/**
     21 * A progress monitor used in {@link org.openstreetmap.josm.gui.PleaseWaitRunnable}.
     22 * <p>
     23 * Progress is displayed in a dialog window ({@link PleaseWaitDialog}).
     24 */
    2025public class PleaseWaitProgressMonitor extends AbstractProgressMonitor {
    2126
  • trunk/src/org/openstreetmap/josm/gui/progress/ProgressMonitor.java

    r11713 r12259  
    55
    66/**
     7 * An interface for displaying the progress of a task.
     8 * <p>
    79 * Typical use case is:
    810 * <pre>
     
    2123 * {@link #subTask(String)} and {@link #indeterminateSubTask(String)} has nothing to do with logical
    2224 * structure of the work, they just show task title to the user.
    23  *
     25 * <p>
    2426 * If task consists of multiple tasks then {@link #createSubTaskMonitor(int, boolean)} may be used. It
    2527 * will create new ProgressMonitor, then can be passed to the subtask. Subtask doesn't know whether
    2628 * it runs standalone or as a part of other task. Progressbar will be updated so that total progress is
    2729 * shown, not just progress of the subtask
    28  *
     30 * <p>
    2931 * All ProgressMonitor implementations should be thread safe.
    3032 *
  • trunk/src/org/openstreetmap/josm/io/imagery/ImageryReader.java

    r11975 r12259  
    3131import org.xml.sax.helpers.DefaultHandler;
    3232
     33/**
     34 * Reader to parse the list of available imagery servers from an XML definition file.
     35 * <p>
     36 * The format is specified in the <a href="https://josm.openstreetmap.de/wiki/Maps">JOSM wiki</a>.
     37 */
    3338public class ImageryReader implements Closeable {
    3439
Note: See TracChangeset for help on using the changeset viewer.