Changeset 34079 in osm for applications

Timestamp:

2018-02-20T21:31:41+01:00 (7 years ago)

Author:

donvip

Message:

see #josm15985 - fix help topic and javadoc warnings

Location:

applications/editors/josm/plugins/wikipedia

Files:

• .settings/org.eclipse.jdt.core.prefs (modified) (3 diffs)
• src/org/wikipedia/WikipediaApp.java (modified) (4 diffs)
• src/org/wikipedia/actions/FetchWikidataAction.java (modified) (1 diff)
• src/org/wikipedia/actions/WikipediaCopyTemplate.java (modified) (1 diff)
• src/org/wikipedia/gui/WikidataTagCellRenderer.java (modified) (1 diff)
• src/org/wikipedia/gui/WikipediaToggleDialog.java (modified) (2 diffs)
• src/org/wikipedia/io/SophoxDownloadReader.java (modified) (1 diff)
• src/org/wikipedia/tools/Debouncer.java (modified) (1 diff)

applications/editors/josm/plugins/wikipedia/.settings/org.eclipse.jdt.core.prefs

@@ -17 +17 @@
 org.eclipse.jdt.core.compiler.debug.localVariable=generate
 org.eclipse.jdt.core.compiler.debug.sourceFile=generate
+org.eclipse.jdt.core.compiler.doc.comment.support=enabled
 org.eclipse.jdt.core.compiler.problem.annotationSuperInterface=warning
 org.eclipse.jdt.core.compiler.problem.assertIdentifier=error
@@ -40 +41 @@
 org.eclipse.jdt.core.compiler.problem.incompleteEnumSwitch=warning
 org.eclipse.jdt.core.compiler.problem.indirectStaticAccess=ignore
+org.eclipse.jdt.core.compiler.problem.invalidJavadoc=warning
+org.eclipse.jdt.core.compiler.problem.invalidJavadocTags=enabled
+org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsDeprecatedRef=enabled
+org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsNotVisibleRef=enabled
+org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsVisibility=private
 org.eclipse.jdt.core.compiler.problem.localVariableHiding=ignore
 org.eclipse.jdt.core.compiler.problem.methodWithConstructorName=warning
@@ -46 +52 @@
 org.eclipse.jdt.core.compiler.problem.missingEnumCaseDespiteDefault=disabled
 org.eclipse.jdt.core.compiler.problem.missingHashCodeMethod=ignore
+org.eclipse.jdt.core.compiler.problem.missingJavadocComments=ignore
+org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=disabled
+org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=public
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=return_tag
+org.eclipse.jdt.core.compiler.problem.missingJavadocTags=warning
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagsMethodTypeParameters=disabled
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=disabled
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagsVisibility=private
 org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotation=ignore
 org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotationForInterfaceMethodImplementation=enabled

applications/editors/josm/plugins/wikipedia/src/org/wikipedia/WikipediaApp.java

@@ -29 +29 @@
 import javax.xml.parsers.ParserConfigurationException;
 
-import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.data.coor.LatLon;
 import org.openstreetmap.josm.data.osm.OsmPrimitive;
@@ -222 +221 @@
     /**
      * Returns a map mapping wikipedia articles to wikidata ids.
+     * @param articles wikipedia article names
+     * @return article / wikidata id map
      */
     public Map<String, String> getWikidataForArticles(Collection<String> articles) {
@@ -252 +253 @@
      * Get Wikidata IDs. For any unknown IDs, resolve them (normalize and get redirects),
      * and try getting Wikidata IDs again
+     * @param articles wikipedia article names
+     * @return article / wikidata id map
      */
     private Map<String, String> resolveWikidataItems(Collection<String> articles) {
@@ -323 +326 @@
      * Given a list of wikipedia titles, returns a map of corresponding normalized title names,
      * or if the title is a redirect page, the result is the redirect target.
+     * @param articles wikipedia articles
+     * @return article / wikidata id map
      */
     private Map<String, String> resolveRedirectsForArticles(Collection<String> articles) {

applications/editors/josm/plugins/wikipedia/src/org/wikipedia/actions/FetchWikidataAction.java

@@ -15 +15 @@
 import javax.swing.JOptionPane;
 
-import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.actions.JosmAction;
 import org.openstreetmap.josm.command.ChangePropertyCommand;

applications/editors/josm/plugins/wikipedia/src/org/wikipedia/actions/WikipediaCopyTemplate.java

@@ -47 +47 @@
     /**
      * Class to hold copy templates for serialization using {@link Preferences}.
-     * Public visibility is needed for reflection used in {@link Preferences#getListOfStructs}.
+     * Public visibility is needed for reflection used in {@link Preferences#getListOfMaps}.
      */
     @SuppressWarnings("WeakerAccess")

applications/editors/josm/plugins/wikipedia/src/org/wikipedia/gui/WikidataTagCellRenderer.java

@@ -19 +19 @@
 import javax.swing.table.DefaultTableCellRenderer;
 
-import org.openstreetmap.josm.Main;
 import org.openstreetmap.josm.gui.util.GuiHelper;
 import org.openstreetmap.josm.tools.Logging;

applications/editors/josm/plugins/wikipedia/src/org/wikipedia/gui/WikipediaToggleDialog.java

@@ -2 +2 @@
 package org.wikipedia.gui;
 
+import static org.openstreetmap.josm.gui.help.HelpUtil.ht;
 import static org.openstreetmap.josm.tools.I18n.tr;
 
@@ -367 +368 @@
 
     @Override
+    public String helpTopic() {
+        return ht("/Plugin/Wikipedia");
+    }
+
+    @Override
     public void showNotify() {
         DatasetEventManager.getInstance().addDatasetListener(dataChangedAdapter, FireMode.IN_EDT_CONSOLIDATED);

applications/editors/josm/plugins/wikipedia/src/org/wikipedia/io/SophoxDownloadReader.java

@@ -68 +68 @@
      * @param sophoxServer The Sophox server to use
      * @param sophoxQuery  The Sophox query
+     * @param asNewLayer if the data should be downloaded into a new layer
+     * @param downloadReferrers if the referrers of the object should be downloaded as well
+     * @param downloadFull if the members of a relation should be downloaded as well 
      */
     public SophoxDownloadReader(Bounds downloadArea, String sophoxServer, String sophoxQuery,

applications/editors/josm/plugins/wikipedia/src/org/wikipedia/tools/Debouncer.java

@@ -18 +18 @@
      * Debounces {@code callable} by {@code delay}, i.e., schedules it to be executed after {@code delay},
      * or cancels its execution if the method is called with the same key within the {@code delay} again.
+     * @param key key
+     * @param runnable runnable to be scheduled 
+     * @param delay delay value
+     * @param unit delay time unit
      */
     public void debounce(final Object key, final Runnable runnable, long delay, TimeUnit unit) {