Changeset 8958 in josm for trunk/src/org/openstreetmap

Timestamp:

2015-10-27T19:15:14+01:00 (9 years ago)

Author:

Don-vip

Message:

update javadoc + checkstyle fix + update presets links

Location:

trunk/src/org/openstreetmap/josm

Files:

• actions/SplitWayAction.java (modified) (1 diff)
• data/osm/visitor/paint/MapRendererFactory.java (modified) (1 diff)
• data/validation/TestError.java (modified) (1 diff)
• data/validation/tests/MapCSSTagChecker.java (modified) (1 diff)
• data/validation/tests/OpeningHourTest.java (modified) (1 diff)
• data/validation/tests/TagChecker.java (modified) (1 diff)
• gui/ConditionalOptionPaneUtil.java (modified) (1 diff)
• gui/FileDrop.java (modified) (2 diffs)
• gui/MainMenu.java (modified) (1 diff)
• gui/MapFrame.java (modified) (1 diff)
• gui/OsmPrimitivRenderer.java (modified) (2 diffs)
• gui/SideButton.java (modified) (1 diff)
• gui/SplashScreen.java (modified) (1 diff)
• gui/dialogs/CommandStackDialog.java (modified) (1 diff)
• gui/dialogs/ToggleDialog.java (modified) (1 diff)
• gui/dialogs/relation/MemberRoleCellEditor.java (modified) (1 diff)
• gui/layer/Layer.java (modified) (3 diffs)
• gui/mappaint/BoxTextElemStyle.java (modified) (3 diffs)
• gui/mappaint/MapImage.java (modified) (1 diff)
• gui/mappaint/Range.java (modified) (1 diff)
• gui/mappaint/mapcss/Condition.java (modified) (11 diffs)
• gui/preferences/PreferenceSetting.java (modified) (1 diff)
• gui/preferences/SourceEditor.java (modified) (3 diffs)
• gui/preferences/SubPreferenceSetting.java (modified) (1 diff)
• gui/tagging/ac/AutoCompletionItemPriority.java (modified) (1 diff)
• gui/tagging/presets/TaggingPreset.java (modified) (2 diffs)
• gui/tagging/presets/TaggingPresetReader.java (modified) (3 diffs)

trunk/src/org/openstreetmap/josm/actions/SplitWayAction.java

@@ -301 +301 @@
      * @since 8954
      */
-    public static abstract class Strategy {
+    public abstract static class Strategy {
 
         /**

trunk/src/org/openstreetmap/josm/data/osm/visitor/paint/MapRendererFactory.java

@@ -258 +258 @@
     /**
      * <p>Creates an instance of the currently active renderer.</p>
+     * @return an instance of the currently active renderer
      *
      * @throws MapRendererFactoryException if creating an instance fails

trunk/src/org/openstreetmap/josm/data/validation/TestError.java

@@ -215 +215 @@
 
     /**
-     * Sets the ignore state for this error
+     * Returns the ignore state for this error.
+     * @return the ignore state for this error
      */
     public String getIgnoreState() {

trunk/src/org/openstreetmap/josm/data/validation/tests/MapCSSTagChecker.java

@@ -149 +149 @@
         /**
          * Creates the fixing {@link Command} for the given primitive. The {@code matchingSelector} is used to evaluate placeholders
-         * (cf. {@link org.openstreetmap.josm.data.validation.tests.MapCSSTagChecker.TagCheck#insertArguments(Selector, String, OsmPrimitive)}).
+         * (cf. {@link MapCSSTagChecker.TagCheck#insertArguments(Selector, String, OsmPrimitive)}).
+         * @param p OSM primitive
+         * @param matchingSelector  matching selector
+         * @return fix command
          */
         abstract Command createCommand(final OsmPrimitive p, final Selector matchingSelector);

trunk/src/org/openstreetmap/josm/data/validation/tests/OpeningHourTest.java

@@ -226 +226 @@
     /**
      * Translates and shortens the error/warning message.
+     * @param key OSM key
+     * @param o error/warnign message
+     * @return translated/shortened error/warnign message
      */
     private String getErrorMessage(String key, Object o) {

trunk/src/org/openstreetmap/josm/data/validation/tests/TagChecker.java

@@ -296 +296 @@
      * Checks given string (key or value) if it contains characters with code below 0x20 (either newline or some other special characters)
      * @param s string to check
+     * @return {@code true} if {@code s} contains characters with code below 0x20
      */
     private static boolean containsLow(String s) {

trunk/src/org/openstreetmap/josm/gui/ConditionalOptionPaneUtil.java

@@ -74 +74 @@
      * (in order to provide a "Do not show again (this operation)" option).
      * @param prefKey the preference key
+     * @return {@code true} if the key has been marked to be part of a bulk operation
      */
     public static boolean isInBulkOperation(final String prefKey) {

trunk/src/org/openstreetmap/josm/gui/FileDrop.java

@@ -34 +34 @@
 import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.actions.OpenFileAction;
-import org.openstreetmap.josm.gui.FileDrop.TransferableObject;
 
 // CHECKSTYLE.OFF: HideUtilityClassConstructor
@@ -227 +226 @@
     }
 
-    /** Determine if the dragged data is a file list. */
+    /**
+     * Determines if the dragged data is a file list.
+     * @param evt the drag event
+     * @return {@code true} if the dragged data is a file list
+     */
     private static boolean isDragOk(final DropTargetDragEvent evt) {
         boolean ok = false;

trunk/src/org/openstreetmap/josm/gui/MainMenu.java

@@ -846 +846 @@
     /**
      * Create search field.
+     * @return the search field
      */
     private DisableShortcutsOnFocusGainedTextField createSearchField() {

trunk/src/org/openstreetmap/josm/gui/MapFrame.java

@@ -330 +330 @@
      * Call this to add new toggle dialogs to the left button-list
      * @param dlg The toggle dialog. It must not be in the list already.
+     * @return button allowing to toggle the dialog
      */
     public IconToggleButton addToggleDialog(final ToggleDialog dlg, boolean isExpert) {

trunk/src/org/openstreetmap/josm/gui/OsmPrimitivRenderer.java

@@ -104 +104 @@
 
     /**
-     * Can be overridden to customize the Text
+     * Returns the text representing an OSM primitive in a component.
+     * Can be overridden to customize the text
+     * @param value OSM primitive
+     * @return text representing the OSM primitive
      */
     protected String getComponentText(OsmPrimitive value) {
@@ -111 +114 @@
 
     /**
+     * Returns the text representing an OSM primitive in a tooltip.
      * Can be overridden to customize the ToolTipText
+     * @param value OSM primitive
+     * @return text representing the OSM primitive
      */
     protected String getComponentToolTipText(OsmPrimitive value) {

trunk/src/org/openstreetmap/josm/gui/SideButton.java

@@ -69 +69 @@
     }
 
-    /** scales the given image proportionally so that the height is "iconHeight" **/
+    /**
+     * Scales the given image proportionally so that the height is "iconHeight"
+     * @param im original image
+     * @return scaled image
+     */
     private static ImageIcon getScaledImage(Image im) {
         int newWidth = im.getWidth(null) *  iconHeight / im.getHeight(null);

trunk/src/org/openstreetmap/josm/gui/SplashScreen.java

@@ -137 +137 @@
         /**
          * Returns a HTML representation for this task.
+         * @param sb a {@code StringBuilder} used to build the HTML code
+         * @return {@code sb}
          */
         public abstract StringBuilder toHtml(StringBuilder sb);

trunk/src/org/openstreetmap/josm/gui/dialogs/CommandStackDialog.java

@@ -321 +321 @@
      * Wraps a command in a CommandListMutableTreeNode.
      * Recursively adds child commands.
+     * @param c the command
+     * @return the resulting node
      */
     protected CommandListMutableTreeNode getNodeForCommand(PseudoCommand c, int idx) {

trunk/src/org/openstreetmap/josm/gui/dialogs/ToggleDialog.java

@@ -833 +833 @@
     }
 
-    /***
+    /*
      * The following methods are intended to be overridden, in order to customize
      * the toggle dialog behavior.
-     **/
-
-    /**
-     * Default size of the detached dialog.
+     */
+
+    /**
+     * Returns the default size of the detached dialog.
      * Override this method to customize the initial dialog size.
+     * @return the default size of the detached dialog
      */
     protected Dimension getDefaultDetachedSize() {

trunk/src/org/openstreetmap/josm/gui/dialogs/relation/MemberRoleCellEditor.java

@@ -52 +52 @@
     }
 
-    /** Returns the edit field for this cell editor. */
+    /**
+     * Returns the edit field for this cell editor.
+     * @return the edit field for this cell editor
+     */
     public AutoCompletingTextField getEditor() {
         return editor;

trunk/src/org/openstreetmap/josm/gui/layer/Layer.java

@@ -174 +174 @@
      * Return a representative small image for this layer. The image must not
      * be larger than 64 pixel in any dimension.
+     * @return layer icon
      */
     public abstract Icon getIcon();
@@ -182 +183 @@
      *      is used. When this is true, then even for custom coloring the base
      *      color is returned - mainly for layer internal use.
+     * @return layer color
      */
     public Color getColor(boolean ignoreCustom) {
@@ -225 +227 @@
      * have correct equals implementation.
      *
-     * Use SeparatorLayerAction.INSTANCE instead of new JSeparator
-     *
+     * Use {@link SeparatorLayerAction#INSTANCE} instead of new JSeparator
+     * @return menu actions for this layer
      */
     public abstract Action[] getMenuEntries();

trunk/src/org/openstreetmap/josm/gui/mappaint/BoxTextElemStyle.java

@@ -35 +35 @@
 
         /**
-         * The box
+         * Returns the box.
+         * @return the box
          */
         public Rectangle getBox() {
@@ -42 +43 @@
 
         /**
-         * True, if the box can change in future calls of the BoxProvider get() method
+         * Determines if the box can change in future calls of the {@link BoxProvider#get()} method
+         * @return {@code true} if the box can change in future calls of the {@code BoxProvider#get()} method
          */
         public boolean isTemporary() {
@@ -52 +54 @@
         private Rectangle box;
 
+        /**
+         * Constructs a new {@code SimpleBoxProvider}.
+         * @param box the box
+         */
         public SimpleBoxProvider(Rectangle box) {
             this.box = box;

trunk/src/org/openstreetmap/josm/gui/mappaint/MapImage.java

@@ -137 +137 @@
 
     /**
-     * Returns true, if image is not completely loaded and getImage() returns a temporary image.
+     * Determines if image is not completely loaded and {@code getImage()} returns a temporary image.
+     * @return {@code true} if image is not completely loaded and getImage() returns a temporary image
      */
     public boolean isTemporary() {

trunk/src/org/openstreetmap/josm/gui/mappaint/Range.java

@@ -32 +32 @@
     /**
      * provides the intersection of 2 overlapping ranges
+     * @param a first range
+     * @param b second range
+     * @return intersection of {@code a} and {@code b}
      */
     public static Range cut(Range a, Range b) {

trunk/src/org/openstreetmap/josm/gui/mappaint/mapcss/Condition.java

@@ -520 +520 @@
         /**
          * {@code closed} tests whether the way is closed or the relation is a closed multipolygon
+         * @param e MapCSS environment
+         * @return {@code true} if the way is closed or the relation is a closed multipolygon
          */
         static boolean closed(Environment e) {
@@ -531 +533 @@
         /**
          * {@code :modified} tests whether the object has been modified.
-         * @see OsmPrimitive#isModified() ()
+         * @param e MapCSS environment
+         * @return {@code true} if the object has been modified
+         * @see OsmPrimitive#isModified()
          */
         static boolean modified(Environment e) {
@@ -539 +543 @@
         /**
          * {@code ;new} tests whether the object is new.
+         * @param e MapCSS environment
+         * @return {@code true} if the object is new
          * @see OsmPrimitive#isNew()
          */
@@ -547 +553 @@
         /**
          * {@code :connection} tests whether the object is a connection node.
+         * @param e MapCSS environment
+         * @return {@code true} if the object is a connection node
          * @see Node#isConnectionNode()
          */
@@ -555 +563 @@
         /**
          * {@code :tagged} tests whether the object is tagged.
+         * @param e MapCSS environment
+         * @return {@code true} if the object is tagged
          * @see OsmPrimitive#isTagged()
          */
@@ -563 +573 @@
         /**
          * {@code :same-tags} tests whether the object has the same tags as its child/parent.
+         * @param e MapCSS environment
+         * @return {@code true} if the object has the same tags as its child/parent
          * @see OsmPrimitive#hasSameInterestingTags(OsmPrimitive)
          */
@@ -571 +583 @@
         /**
          * {@code :area-style} tests whether the object has an area style. This is useful for validators.
+         * @param e MapCSS environment
+         * @return {@code true} if the object has an area style
          * @see ElemStyles#hasAreaElemStyle(OsmPrimitive, boolean)
          */
@@ -580 +594 @@
         /**
          * {@code unconnected}: tests whether the object is a unconnected node.
+         * @param e MapCSS environment
+         * @return {@code true} if the object is a unconnected node
          */
         static boolean unconnected(Environment e) {
@@ -587 +603 @@
         /**
          * {@code righthandtraffic} checks if there is right-hand traffic at the current location.
+         * @param e MapCSS environment
+         * @return {@code true} if there is right-hand traffic at the current location
          * @see ExpressionFactory.Functions#is_right_hand_traffic(Environment)
          */
@@ -595 +613 @@
         /**
          * {@code unclosed-multipolygon} tests whether the object is an unclosed multipolygon.
+         * @param e MapCSS environment
+         * @return {@code true} if the object is an unclosed multipolygon
          */
         static boolean unclosed_multipolygon(Environment e) {
@@ -606 +626 @@
         /**
          * {@code in-downloaded-area} tests whether the object is within source area ("downloaded area").
+         * @param e MapCSS environment
+         * @return {@code true} if the object is within source area ("downloaded area")
          * @see InDataSourceArea
          */

trunk/src/org/openstreetmap/josm/gui/preferences/PreferenceSetting.java

@@ -16 +16 @@
      * Called when OK is pressed to save the setting in the preferences file.
      * Return true when restart is required.
+     * @return {@code true} if restart is required
      */
     boolean ok();

trunk/src/org/openstreetmap/josm/gui/preferences/SourceEditor.java

@@ -393 +393 @@
     /**
      * Load the list of source entries that the user has configured.
+     * @return list of source entries that the user has configured
      */
     public abstract Collection<? extends SourceEntry> getInitialSourcesList();
@@ -398 +399 @@
     /**
      * Load the list of configured icon paths.
+     * @return list of configured icon paths
      */
     public abstract Collection<String> getInitialIconPathsList();
@@ -403 +405 @@
     /**
      * Get the default list of entries (used when resetting the list).
+     * @return default list of entries
      */
     public abstract Collection<ExtendedSourceEntry> getDefault();

trunk/src/org/openstreetmap/josm/gui/preferences/SubPreferenceSetting.java

@@ -12 +12 @@
     /**
      * Returns the preference setting (displayed in the specified preferences tab pane) that contains this preference setting.
+     * @return parent preference setting
      */
     TabPreferenceSetting getTabPreferenceSetting(final PreferenceTabbedPane gui);

trunk/src/org/openstreetmap/josm/gui/tagging/ac/AutoCompletionItemPriority.java

@@ -106 +106 @@
      * Merges two priorities.
      * The resulting priority is always >= the original ones.
+     * @return the merged priority
      */
     public AutoCompletionItemPriority mergeWith(AutoCompletionItemPriority other) {

trunk/src/org/openstreetmap/josm/gui/tagging/presets/TaggingPreset.java

@@ -141 +141 @@
     /**
      * Returns the translated name of this preset, prefixed with the group names it belongs to.
+     * @return the translated name of this preset, prefixed with the group names it belongs to
      */
     public String getName() {
@@ -148 +149 @@
     /**
      * Returns the non translated name of this preset, prefixed with the (non translated) group names it belongs to.
+     * @return the non translated name of this preset, prefixed with the (non translated) group names it belongs to
      */
     public String getRawName() {

trunk/src/org/openstreetmap/josm/gui/tagging/presets/TaggingPresetReader.java

@@ -91 +91 @@
         /**
          * Returns the last inserted element.
+         * @return the last inserted element
          */
         public E getLast() {
@@ -402 +403 @@
 
     /**
-     * Returns true if icon images should be loaded.
+     * Determines if icon images should be loaded.
+     * @return {@code true} if icon images should be loaded
      */
     public static boolean isLoadIcons() {
@@ -410 +412 @@
     /**
      * Sets whether icon images should be loaded.
+     * @param loadIcons {@code true} if icon images should be loaded
      */
     public static void setLoadIcons(boolean loadIcons) {