Changeset 5899 in josm

Timestamp:

2013-04-21T16:34:38+02:00 (11 years ago)

Author:

stoecker

Message:

fix javadoc

Location:

trunk/src/org/openstreetmap/josm/gui

Files:

• download/DownloadSelection.java (modified) (1 diff)
• help/HelpUtil.java (modified) (2 diffs)
• history/HistoryBrowserModel.java (modified) (1 diff)
• io/ChangesetManagementPanel.java (modified) (1 diff)
• io/FilenameCellEditor.java (modified) (1 diff)
• mappaint/ElemStyles.java (modified) (1 diff)
• oauth/FullyAutomaticAuthorizationUI.java (modified) (5 diffs)
• oauth/OAuthAuthorizationWizard.java (modified) (2 diffs)
• oauth/RetrieveAccessTokenTask.java (modified) (1 diff)
• preferences/ServerAccessPreference.java (modified) (2 diffs)
• preferences/server/OAuthAuthenticationPreferencesPanel.java (modified) (1 diff)
• preferences/server/ProxyPreferencesPanel.java (modified) (2 diffs)
• tagging/TaggingPresetSearchDialog.java (modified) (1 diff)
• widgets/AbstractIdTextField.java (modified) (1 diff)
• widgets/AbstractTextComponentValidator.java (modified) (1 diff)
• widgets/TextContextualPopupMenu.java (modified) (1 diff)

trunk/src/org/openstreetmap/josm/gui/download/DownloadSelection.java

@@ -15 +15 @@
      * the current download area.
      *
-     * @param are the current download area
+     * @param area the current download area
      */
     public void setDownloadArea(Bounds area);

trunk/src/org/openstreetmap/josm/gui/help/HelpUtil.java

@@ -209 +209 @@
      * of {@link HelpAction}.
      *
-     * @return
+     * @return instance of help action
      */
     static private Action getHelpAction() {
@@ -227 +227 @@
      *
      * @param component the component  the component
-     * @param topic the help topic. Set to the default help topic if null.
+     * @param relativeHelpTopic the help topic. Set to the default help topic if null.
      */
     static public void setHelpContext(JComponent component, String relativeHelpTopic) {

trunk/src/org/openstreetmap/josm/gui/history/HistoryBrowserModel.java

@@ -337 +337 @@
      * in time (see {@link PointInTimeType}).
      *
-     * @param reference the reference history primitive. Must not be null.
-     * @throws IllegalArgumentException thrown if reference is null
+     * @param current the reference history primitive. Must not be {@code null}.
+     * @throws IllegalArgumentException thrown if reference is {@code null}
      * @throws IllegalStateException thrown if this model isn't a assigned a history yet
      * @throws IllegalArgumentException if reference isn't an history primitive for the history managed by this mode

trunk/src/org/openstreetmap/josm/gui/io/ChangesetManagementPanel.java

@@ -37 +37 @@
  * It is displayed as one of the configuration panels in the {@link UploadDialog}.
  *
- * ChangesetManagementPanel is a source for {@link PropertyChangeEvent}s. Clients can listen
+ * ChangesetManagementPanel is a source for {@link java.beans.PropertyChangeEvent}s. Clients can listen
  * to
  * <ul>

trunk/src/org/openstreetmap/josm/gui/io/FilenameCellEditor.java

@@ -27 +27 @@
 /**
  * This is a {@link TableCellEditor} for filenames. It provides a text input field and
- * a button for launchinig a {@link JFileChooser}.
- *
- *
+ * a button for launchinig a {@link javax.swing.JFileChooser}.
  */
 class FilenameCellEditor extends JPanel implements TableCellEditor {

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

@@ -48 +48 @@
      * @param osm the primitive
      * @param scale the scale (in meters per 100 pixel)
-     * @param nc
-     * @return
+     * @param nc display component
+     * @return list of styles
      */
     public StyleList get(OsmPrimitive osm, double scale, NavigatableComponent nc) {

trunk/src/org/openstreetmap/josm/gui/oauth/FullyAutomaticAuthorizationUI.java

@@ -71 +71 @@
      * Builds the panel with the three privileges the user can grant JOSM
      *
-     * @return
+     * @return constructed panel for the privileges
      */
     protected VerticallyScrollablePanel buildGrantsPanel() {
@@ -81 +81 @@
      * Builds the panel for entering the username and password
      *
-     * @return
+     * @return constructed panel for the creditentials
      */
     protected VerticallyScrollablePanel buildUserNamePasswordPanel() {
@@ -180 +180 @@
     /**
      * Initializes the panel with values from the preferences
+     * @param pref Preferences structure
      */
     @Override
@@ -204 +205 @@
      * Builds the panel with the action button  for starting the authorisation
      *
-     * @return
+     * @return constructed button panel
      */
     protected JPanel buildActionButtonPanel() {
@@ -219 +220 @@
      * Builds the panel which displays the generated Access Token.
      *
-     * @return
+     * @return constructed panel for the results
      */
     protected JPanel buildResultsPanel() {

trunk/src/org/openstreetmap/josm/gui/oauth/OAuthAuthorizationWizard.java

@@ -69 +69 @@
      * Builds the row with the action buttons
      *
-     * @return
+     * @return panel with buttons
      */
     protected JPanel buildButtonRow(){
@@ -89 +89 @@
      * Builds the panel with general information in the header
      *
-     * @return
+     * @return panel woth information display
      */
     protected JPanel buildHeaderInfoPanel() {

trunk/src/org/openstreetmap/josm/gui/oauth/RetrieveAccessTokenTask.java

@@ -100 +100 @@
      * Replies true if the task was canceled.
      *
-     * @return
+     * @return {@code true} if user aborted operation
      */
     public boolean isCanceled() {

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

@@ -54 +54 @@
      * Builds the tabbed pane with the server preferences
      *
-     * @return
+     * @return panel with server preferences tabs
      */
     protected JPanel buildTabbedServerPreferences() {
@@ -77 +77 @@
      * Builds the panel for entering the server access preferences
      *
-     * @return
+     * @return preferences panel for server settings
      */
     protected JPanel buildContentPanel() {

trunk/src/org/openstreetmap/josm/gui/preferences/server/OAuthAuthenticationPreferencesPanel.java

@@ -55 +55 @@
      * Builds the panel for entering the advanced OAuth parameters
      *
-     * @return
+     * @return panel with advanced settings
      */
     protected JPanel buildAdvancedPropertiesPanel() {

trunk/src/org/openstreetmap/josm/gui/preferences/server/ProxyPreferencesPanel.java

@@ -87 +87 @@
      * Builds the panel for the HTTP proxy configuration
      *
-     * @return
+     * @return panel with HTTP proxy configuration
      */
     protected JPanel buildHttpProxyConfigurationPanel() {
@@ -163 +163 @@
      * Builds the panel for the SOCKS proxy configuration
      *
-     * @return
+     * @return panel with SOCKS proxy configuration
      */
     protected JPanel buildSocksProxyConfigurationPanel() {

trunk/src/org/openstreetmap/josm/gui/tagging/TaggingPresetSearchDialog.java

@@ -343 +343 @@
     /**
      * Search expression can be in form: "group1/group2/name" where names can contain multiple words
-     *
-     * When groups are given,
-     *
-     *
-     * @param text
      */
     private void filterPresets() {

trunk/src/org/openstreetmap/josm/gui/widgets/AbstractIdTextField.java

@@ -29 +29 @@
      * @param klass The validator class
      * @param columns The number of columns to use to calculate the preferred width
-     * @see JTextField#JTextField(int)
+     * @see JosmTextField#JosmTextField(int)
      */
     public AbstractIdTextField(Class<T> klass, int columns) {

trunk/src/org/openstreetmap/josm/gui/widgets/AbstractTextComponentValidator.java

@@ -28 +28 @@
  *   <li>the content of the text component changes (the validator is a {@link DocumentListener})</li>
  *   <li>the text component loses focus (the validator is a {@link FocusListener})</li>
- *   <li>the text component is a {@link JTextField} and an {@link ActionEvent} is detected</li>
+ *   <li>the text component is a {@link JosmTextField} and an {@link ActionEvent} is detected</li>
  * </ul>
  *

trunk/src/org/openstreetmap/josm/gui/widgets/TextContextualPopupMenu.java

@@ -61 +61 @@
      * @param component The text component that will display the menu and handle its actions.
      * @return {@code this}
-     * @see #detach(JTextComponent)
+     * @see #detach()
      */
     protected TextContextualPopupMenu attach(JTextComponent component) {