Creates an instance of the currently active renderer.
+ * @return an instance of the currently active renderer * * @throws MapRendererFactoryException if creating an instance fails Index: trunk/src/org/openstreetmap/josm/data/validation/TestError.java =================================================================== --- trunk/src/org/openstreetmap/josm/data/validation/TestError.java (revision 8957) +++ trunk/src/org/openstreetmap/josm/data/validation/TestError.java (revision 8958) @@ -215,5 +215,6 @@ /** - * Sets the ignore state for this error + * Returns the ignore state for this error. + * @return the ignore state for this error */ public String getIgnoreState() { Index: trunk/src/org/openstreetmap/josm/data/validation/tests/MapCSSTagChecker.java =================================================================== --- trunk/src/org/openstreetmap/josm/data/validation/tests/MapCSSTagChecker.java (revision 8957) +++ trunk/src/org/openstreetmap/josm/data/validation/tests/MapCSSTagChecker.java (revision 8958) @@ -149,5 +149,8 @@ /** * 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); Index: trunk/src/org/openstreetmap/josm/data/validation/tests/OpeningHourTest.java =================================================================== --- trunk/src/org/openstreetmap/josm/data/validation/tests/OpeningHourTest.java (revision 8957) +++ trunk/src/org/openstreetmap/josm/data/validation/tests/OpeningHourTest.java (revision 8958) @@ -226,4 +226,7 @@ /** * 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) { Index: trunk/src/org/openstreetmap/josm/data/validation/tests/TagChecker.java =================================================================== --- trunk/src/org/openstreetmap/josm/data/validation/tests/TagChecker.java (revision 8957) +++ trunk/src/org/openstreetmap/josm/data/validation/tests/TagChecker.java (revision 8958) @@ -296,4 +296,5 @@ * 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) { Index: trunk/src/org/openstreetmap/josm/gui/ConditionalOptionPaneUtil.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/ConditionalOptionPaneUtil.java (revision 8957) +++ trunk/src/org/openstreetmap/josm/gui/ConditionalOptionPaneUtil.java (revision 8958) @@ -74,4 +74,5 @@ * (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) { Index: trunk/src/org/openstreetmap/josm/gui/FileDrop.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/FileDrop.java (revision 8957) +++ trunk/src/org/openstreetmap/josm/gui/FileDrop.java (revision 8958) @@ -34,5 +34,4 @@ import org.openstreetmap.josm.Main; import org.openstreetmap.josm.actions.OpenFileAction; -import org.openstreetmap.josm.gui.FileDrop.TransferableObject; // CHECKSTYLE.OFF: HideUtilityClassConstructor @@ -227,5 +226,9 @@ } - /** 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; Index: trunk/src/org/openstreetmap/josm/gui/MainMenu.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/MainMenu.java (revision 8957) +++ trunk/src/org/openstreetmap/josm/gui/MainMenu.java (revision 8958) @@ -846,4 +846,5 @@ /** * Create search field. + * @return the search field */ private DisableShortcutsOnFocusGainedTextField createSearchField() { Index: trunk/src/org/openstreetmap/josm/gui/MapFrame.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/MapFrame.java (revision 8957) +++ trunk/src/org/openstreetmap/josm/gui/MapFrame.java (revision 8958) @@ -330,4 +330,5 @@ * 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) { Index: trunk/src/org/openstreetmap/josm/gui/OsmPrimitivRenderer.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/OsmPrimitivRenderer.java (revision 8957) +++ trunk/src/org/openstreetmap/josm/gui/OsmPrimitivRenderer.java (revision 8958) @@ -104,5 +104,8 @@ /** - * 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,5 +114,8 @@ /** + * 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) { Index: trunk/src/org/openstreetmap/josm/gui/SideButton.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/SideButton.java (revision 8957) +++ trunk/src/org/openstreetmap/josm/gui/SideButton.java (revision 8958) @@ -69,5 +69,9 @@ } - /** 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); Index: trunk/src/org/openstreetmap/josm/gui/SplashScreen.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/SplashScreen.java (revision 8957) +++ trunk/src/org/openstreetmap/josm/gui/SplashScreen.java (revision 8958) @@ -137,4 +137,6 @@ /** * 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); Index: trunk/src/org/openstreetmap/josm/gui/dialogs/CommandStackDialog.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/dialogs/CommandStackDialog.java (revision 8957) +++ trunk/src/org/openstreetmap/josm/gui/dialogs/CommandStackDialog.java (revision 8958) @@ -321,4 +321,6 @@ * 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) { Index: trunk/src/org/openstreetmap/josm/gui/dialogs/ToggleDialog.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/dialogs/ToggleDialog.java (revision 8957) +++ trunk/src/org/openstreetmap/josm/gui/dialogs/ToggleDialog.java (revision 8958) @@ -833,12 +833,13 @@ } - /*** + /* * 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() { Index: trunk/src/org/openstreetmap/josm/gui/dialogs/relation/MemberRoleCellEditor.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/dialogs/relation/MemberRoleCellEditor.java (revision 8957) +++ trunk/src/org/openstreetmap/josm/gui/dialogs/relation/MemberRoleCellEditor.java (revision 8958) @@ -52,5 +52,8 @@ } - /** 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; Index: trunk/src/org/openstreetmap/josm/gui/layer/Layer.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/layer/Layer.java (revision 8957) +++ trunk/src/org/openstreetmap/josm/gui/layer/Layer.java (revision 8958) @@ -174,4 +174,5 @@ * 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,4 +183,5 @@ * 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,6 +227,6 @@ * 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(); Index: trunk/src/org/openstreetmap/josm/gui/mappaint/BoxTextElemStyle.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/mappaint/BoxTextElemStyle.java (revision 8957) +++ trunk/src/org/openstreetmap/josm/gui/mappaint/BoxTextElemStyle.java (revision 8958) @@ -35,5 +35,6 @@ /** - * The box + * Returns the box. + * @return the box */ public Rectangle getBox() { @@ -42,5 +43,6 @@ /** - * 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,4 +54,8 @@ private Rectangle box; + /** + * Constructs a new {@code SimpleBoxProvider}. + * @param box the box + */ public SimpleBoxProvider(Rectangle box) { this.box = box; Index: trunk/src/org/openstreetmap/josm/gui/mappaint/MapImage.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/mappaint/MapImage.java (revision 8957) +++ trunk/src/org/openstreetmap/josm/gui/mappaint/MapImage.java (revision 8958) @@ -137,5 +137,6 @@ /** - * 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() { Index: trunk/src/org/openstreetmap/josm/gui/mappaint/Range.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/mappaint/Range.java (revision 8957) +++ trunk/src/org/openstreetmap/josm/gui/mappaint/Range.java (revision 8958) @@ -32,4 +32,7 @@ /** * 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) { Index: trunk/src/org/openstreetmap/josm/gui/mappaint/mapcss/Condition.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/mappaint/mapcss/Condition.java (revision 8957) +++ trunk/src/org/openstreetmap/josm/gui/mappaint/mapcss/Condition.java (revision 8958) @@ -520,4 +520,6 @@ /** * {@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,5 +533,7 @@ /** * {@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,4 +543,6 @@ /** * {@code ;new} tests whether the object is new. + * @param e MapCSS environment + * @return {@code true} if the object is new * @see OsmPrimitive#isNew() */ @@ -547,4 +553,6 @@ /** * {@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,4 +563,6 @@ /** * {@code :tagged} tests whether the object is tagged. + * @param e MapCSS environment + * @return {@code true} if the object is tagged * @see OsmPrimitive#isTagged() */ @@ -563,4 +573,6 @@ /** * {@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,4 +583,6 @@ /** * {@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,4 +594,6 @@ /** * {@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,4 +603,6 @@ /** * {@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,4 +613,6 @@ /** * {@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,4 +626,6 @@ /** * {@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 */ Index: trunk/src/org/openstreetmap/josm/gui/preferences/PreferenceSetting.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/preferences/PreferenceSetting.java (revision 8957) +++ trunk/src/org/openstreetmap/josm/gui/preferences/PreferenceSetting.java (revision 8958) @@ -16,4 +16,5 @@ * 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(); Index: trunk/src/org/openstreetmap/josm/gui/preferences/SourceEditor.java =================================================================== --- trunk/src/org/openstreetmap/josm/gui/preferences/SourceEditor.java (revision 8957) +++ trunk/src/org/openstreetmap/josm/gui/preferences/SourceEditor.java (revision 8958) @@ -393,4 +393,5 @@ /** * Load the list of source entries that the user has configured. + * @return list of source entries that the user has configured */ public abstract Collection getInitialSourcesList(); @@ -398,4 +399,5 @@ /** * Load the list of configured icon paths. + * @return list of configured icon paths */ public abstract Collection