Context Navigation

Changeset 12259 in josm for trunk/src/org

Timestamp:

2017-05-26T01:12:46+02:00 (7 years ago)

Author:

bastiK

Message:

see #14794 - javadoc

Location:

trunk/src/org/openstreetmap/josm

Files:

-              r11171
+              r12259
 import org.openstreetmap.josm.tools.WikiReader;
+/**
+ * Panel that fills the main part of the program window when JOSM has just started.
+ *
+ * It downloads and displays the so called <em>message of the day</em>, which
+ * contains news about recent major changes, warning in case of outdated versions, etc.
+ */
 public final class GettingStarted extends JPanel implements ProxyPreferenceListener {

-              r11760
+              r12259
 package org.openstreetmap.josm.gui.mappaint;
+/**
+ * Interface defining string constants (MapCSS property keys).
+ *
+ * For the implementation of the <code>@supports</code> feature, the list of
+ * supported keys is loaded from this interface using reflection.
+ * @see org.openstreetmap.josm.gui.mappaint.mapcss.MapCSSStyleSource#evalSupportsDeclCondition(java.lang.String, java.lang.Object)
+ */
 public interface StyleKeys {

-              r10001
+              r12259
 import java.util.Map;
+/**
+ * List of named CSS colors as per CSS Color Module Level 3.
+ *
+ * @see <a href="https://drafts.csswg.org/css-color-3/">CSS Color Module Level 3</a>
+ */
 public final class CSSColors {
     private static final Map<String, Color> CSS_COLORS = new HashMap<>();

-              r10600
+              r12259
 import org.openstreetmap.josm.gui.mappaint.StyleKeys;
+/**
+ * A MapCSS Instruction.
+ *
+ * For example a simple assignment like <code>width: 3;</code>, but may also
+ * be a set instruction (<code>set highway;</code>).
+ * A MapCSS {@link MapCSSRule.Declaration} is a list of instructions.
+ */
 @FunctionalInterface
 public interface Instruction extends StyleKeys {
+    /**
+     * Execute the instruction in the given environment.
+     * @param env the environment
+     */
     void execute(Environment env);

-              r11809
+              r12259
 import org.openstreetmap.josm.tools.CheckParameterUtil;
+/**
+ * Style element that displays a repeated image pattern along a way.
+ */
 public class RepeatImageElement extends StyleElement {

-              r11452
+              r12259
 import org.openstreetmap.josm.gui.mappaint.mapcss.Instruction.RelativeFloat;
+/**
+ * Class that defines how objects ({@link OsmPrimitive}) should be drawn on the map.
+ *
+ * Several subclasses of this abstract class implement different drawing features,
+ * like icons for a node or area fill. This class and all its subclasses are immutable
+ * and tend to get shared when multiple objects have the same style (in order to
+ * save memory, see {@link org.openstreetmap.josm.gui.mappaint.StyleCache#intern()}).
+ */
 public abstract class StyleElement implements StyleKeys {
 …
     public boolean defaultSelectedHandling;
+    /**
+     * Construct a new StyleElement
+     * @param majorZindex like z-index, but higher priority
+     * @param zIndex order the objects are drawn
+     * @param objectZindex like z-index, but lower priority
+     * @param isModifier if false, a default line or node symbol is generated
+     * @param defaultSelectedHandling true if default behavior for selected objects
+     * is enabled, false if a style for selected state is given explicitly
+     */
     public StyleElement(float majorZindex, float zIndex, float objectZindex, boolean isModifier, boolean defaultSelectedHandling) {
         this.majorZIndex = majorZindex;

-              r11746
+              r12259
 import org.openstreetmap.josm.tools.bugreport.BugReport;
+/**
+ * A progress monitor used in {@link org.openstreetmap.josm.gui.PleaseWaitRunnable}.
+ * <p>
+ * Progress is displayed in a dialog window ({@link PleaseWaitDialog}).
+ */
 public class PleaseWaitProgressMonitor extends AbstractProgressMonitor {

-              r11713
+              r12259
 /**
+ * An interface for displaying the progress of a task.
+ * <p>
  * Typical use case is:
  * <pre>
 …
  * {@link #subTask(String)} and {@link #indeterminateSubTask(String)} has nothing to do with logical
  * structure of the work, they just show task title to the user.
+ *
+ * <p>
  * If task consists of multiple tasks then {@link #createSubTaskMonitor(int, boolean)} may be used. It
  * will create new ProgressMonitor, then can be passed to the subtask. Subtask doesn't know whether
  * it runs standalone or as a part of other task. Progressbar will be updated so that total progress is
  * shown, not just progress of the subtask
+ *
+ * <p>
  * All ProgressMonitor implementations should be thread safe.
+ *

-              r11975
+              r12259
 import org.xml.sax.helpers.DefaultHandler;
+/**
+ * Reader to parse the list of available imagery servers from an XML definition file.
+ * <p>
+ * The format is specified in the <a href="https://josm.openstreetmap.de/wiki/Maps">JOSM wiki</a>.
+ */
 public class ImageryReader implements Closeable {

Note: See TracChangeset for help on using the changeset viewer.