Changeset 34313 in osm

Timestamp:

2018-06-17T21:38:38+02:00 (6 years ago)

Author:

donvip

Message:

fix javadoc warnings

Location:

applications/editors/josm/plugins/waydownloader

Files:

• .settings/org.eclipse.jdt.core.prefs (modified) (3 diffs)
• src/org/openstreetmap/josm/plugins/waydownloader/WayDownloaderPlugin.java (modified) (3 diffs)

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

@@ -9 +9 @@
 org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.8
 org.eclipse.jdt.core.compiler.compliance=1.8
+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
@@ -32 +33 @@
 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=public
 org.eclipse.jdt.core.compiler.problem.localVariableHiding=ignore
 org.eclipse.jdt.core.compiler.problem.methodWithConstructorName=warning
@@ -38 +44 @@
 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/waydownloader/src/org/openstreetmap/josm/plugins/waydownloader/WayDownloaderPlugin.java

@@ -48 +48 @@
     private Node selectedNode = null;
 
-    /** Plugin constructor called at JOSM startup */
+    /** 
+     * Plugin constructor called at JOSM startup 
+     * @param info plugin info
+     */
     public WayDownloaderPlugin(PluginInformation info) {
         super(info);
@@ -247 +250 @@
     }
 
-    /** Given the node on one end of the way, return the node on the other end */
+    /** 
+     * Given the node on one end of the way, return the node on the other end 
+     * @param way way
+     * @param firstEnd one end
+     * @return other end
+     */
     private Node findOtherEnd(Way way, Node firstEnd) {
         Node otherEnd = way.firstNode();
@@ -277 +285 @@
      * given a selected way, select a node on the end of the way which is not in a downloaded area
      * return true if this worked
+     * @param selection selected way
+     * @return true if a node has been selected
      */
     private boolean workFromWaySelection(Collection<? extends OsmPrimitive> selection) {