Changeset 12334 in josm for trunk/src

Timestamp:

2017-06-08T00:01:06+02:00 (7 years ago)

Author:

michael2402

Message:

Javadoc for SearchAction.

File:

• trunk/src/org/openstreetmap/josm/actions/search/SearchAction.java (modified) (5 diffs)

trunk/src/org/openstreetmap/josm/actions/search/SearchAction.java

@@ -29 +29 @@
 import java.util.function.Predicate;
 
+import javax.swing.BorderFactory;
+import javax.swing.ButtonGroup;
 import javax.swing.JCheckBox;
 import javax.swing.JLabel;
@@ -36 +38 @@
 import javax.swing.text.BadLocationException;
 import javax.swing.text.JTextComponent;
-import javax.swing.BorderFactory;
-import javax.swing.ButtonGroup;
 
 import org.openstreetmap.josm.Main;
@@ -61 +61 @@
 import org.openstreetmap.josm.tools.Utils;
 
+/**
+ * The search action allows the user to search the data layer using a complex search string.
+ *
+ * @see SearchCompiler
+ */
 public class SearchAction extends JosmAction implements ParameterizedAction {
 
+    /**
+     * The default size of the search history
+     */
     public static final int DEFAULT_SEARCH_HISTORY_SIZE = 15;
-    /** Maximum number of characters before the search expression is shortened for display purposes. */
+    /**
+     * Maximum number of characters before the search expression is shortened for display purposes.
+     */
     public static final int MAX_LENGTH_SEARCH_EXPRESSION_DISPLAY = 100;
 
@@ -120 +130 @@
     }
 
+    /**
+     * Gets the search history
+     * @return The last searched terms. Do not modify it.
+     */
     public static Collection<SearchSetting> getSearchHistory() {
         return searchHistory;
     }
 
+    /**
+     * Saves a search to the search history.
+     * @param s The search to save
+     */
     public static void saveToHistory(SearchSetting s) {
         if (searchHistory.isEmpty() || !s.equals(searchHistory.getFirst())) {
@@ -143 +161 @@
     }
 
+    /**
+     * Gets a list of all texts that were recently used in the search
+     * @return The list of search texts.
+     */
     public static List<String> getSearchExpressionHistory() {
         List<String> ret = new ArrayList<>(getSearchHistory().size());