Enable javadoc validation of examples in workspace

and fix more uncovered javadoc problems.

Author: HannesWell

binaries/.settings/org.eclipse.jdt.core.prefs

@@ -46,7 +46,7 @@ org.eclipse.jdt.core.compiler.problem.incompleteEnumSwitch=warning
 org.eclipse.jdt.core.compiler.problem.indirectStaticAccess=warning
 org.eclipse.jdt.core.compiler.problem.invalidJavadoc=error
 org.eclipse.jdt.core.compiler.problem.invalidJavadocTags=enabled
-org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsDeprecatedRef=disabled
+org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsDeprecatedRef=enabled
 org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsNotVisibleRef=disabled
 org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsVisibility=public
 org.eclipse.jdt.core.compiler.problem.localVariableHiding=ignore

examples/.settings_shared/org.eclipse.jdt.core.prefs

@@ -19,6 +19,7 @@ org.eclipse.jdt.core.compiler.compliance=17
 org.eclipse.jdt.core.compiler.debug.lineNumber=generate
 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.APILeak=warning
 org.eclipse.jdt.core.compiler.problem.annotatedTypeArgumentToUnannotated=info
 org.eclipse.jdt.core.compiler.problem.annotationSuperInterface=warning
@@ -47,12 +48,25 @@ org.eclipse.jdt.core.compiler.problem.incompatibleOwningContract=warning
 org.eclipse.jdt.core.compiler.problem.incompleteEnumSwitch=warning
 org.eclipse.jdt.core.compiler.problem.indirectStaticAccess=info
 org.eclipse.jdt.core.compiler.problem.insufficientResourceAnalysis=warning
+org.eclipse.jdt.core.compiler.problem.invalidJavadoc=error
+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
 org.eclipse.jdt.core.compiler.problem.missingDefaultCase=ignore
 org.eclipse.jdt.core.compiler.problem.missingDeprecatedAnnotation=warning
 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=public
 org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotation=warning
 org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotationForInterfaceMethodImplementation=enabled
 org.eclipse.jdt.core.compiler.problem.missingSerialVersion=warning

examples/org.eclipse.swt.examples.ole.win32/src/org/eclipse/swt/examples/ole/win32/OleWebBrowser.java

@@ -14,7 +14,9 @@
 package org.eclipse.swt.examples.ole.win32;
 
 
-import org.eclipse.swt.ole.win32.*;
+import org.eclipse.swt.ole.win32.OLE;
+import org.eclipse.swt.ole.win32.OleAutomation;
+import org.eclipse.swt.ole.win32.Variant;
 
 /**
  * Wrapper for an OleAutomation object used to send commands
@@ -76,7 +78,6 @@ class OleWebBrowser {
 	 * </code>
 	 * 
 	 * @param oleAutomation the OleAutomation object for this control.
-	 * @param oleControlSite the OleControlSite object for this control.
 	 */
 	public OleWebBrowser(OleAutomation oleAutomation) {
 		this.oleAutomation = oleAutomation;
@@ -207,8 +208,6 @@ public void Navigate(String url) {
 
 	/**
 	 * Refreshes the currently viewed page.
-	 *
-	 * @return the platform-defined result code for the "Refresh" method invocation
 	 */
 	public void Refresh(){
 		// dispid= 4294966746, type=METHOD, name="Refresh"
@@ -219,8 +218,6 @@ public void Refresh(){
 
 	/**
 	 * Aborts loading of the currnet page.
-	 *
-	 * @return the platform-defined result code for the "Stop" method invocation
 	 */
 	public void Stop() {
 		// dispid=106, type=METHOD, name="Stop"

examples/org.eclipse.swt.examples/src/org/eclipse/swt/examples/graphics/ColorMenu.java

@@ -282,7 +282,7 @@ public MenuItemListener(Control parent){
 		 *
 		 * @param cl
 		 *            A ColorListener
-		 * @see org.eclipse.swt.examples.graphics.ColorListener.java
+		 * @see org.eclipse.swt.examples.graphics.ColorListener
 		 */
 		public void setColorListener(ColorListener cl) {
 			this.colorListener = cl;

tests/org.eclipse.swt.tests.gtk/ManualTests/org/eclipse/swt/tests/gtk/snippets/Bug491167_TableCursorScrolling.java

@@ -15,10 +15,19 @@
 
 
 import org.eclipse.swt.SWT;
-import org.eclipse.swt.custom.*;
-import org.eclipse.swt.events.*;
-import org.eclipse.swt.layout.*;
-import org.eclipse.swt.widgets.*;
+import org.eclipse.swt.custom.ControlEditor;
+import org.eclipse.swt.custom.TableCursor;
+import org.eclipse.swt.events.KeyAdapter;
+import org.eclipse.swt.events.KeyEvent;
+import org.eclipse.swt.events.SelectionAdapter;
+import org.eclipse.swt.events.SelectionEvent;
+import org.eclipse.swt.layout.FillLayout;
+import org.eclipse.swt.widgets.Display;
+import org.eclipse.swt.widgets.Shell;
+import org.eclipse.swt.widgets.Table;
+import org.eclipse.swt.widgets.TableColumn;
+import org.eclipse.swt.widgets.TableItem;
+import org.eclipse.swt.widgets.Text;
 
 /**
  * This class demonstrates TableCursor
@@ -47,8 +56,8 @@ public void run() {
 
 	/**
 	 * Creates the main window's contents
-	 * 
-	 * @param widget.shell
+	 *
+	 * @param shell
 	 *            the main window
 	 */
 	private void createContents(Shell shell) {
@@ -128,7 +137,7 @@ public void keyPressed(KeyEvent event) {
 
 	/**
 	 * The application entry point
-	 * 
+	 *
 	 * @param args
 	 *            the command line arguments
 	 */

tests/org.eclipse.swt.tests.gtk/ManualTests/org/eclipse/swt/tests/gtk/snippets/Bug573697_MenuBar_CrashShellReparent.java

@@ -24,8 +24,9 @@
 
 /**
  * Description: After fixing the memory leak in bug 573697, we observed crashes
- * on shell re-parenting. In particular, {@link Decorations#fixAccelGroup()}
- * destroyed {@link Decorations#accelGroup} while still in use by GTK.
+ * on shell re-parenting. In particular, in the GTK implementation of
+ * {@link Decorations}'s the method {@code fixAccelGroup()} destroyed
+ * {@code accelGroup} while still in use by GTK.
  * <p>
  * Steps to reproduce:
  * </p>

tests/org.eclipse.swt.tests.gtk/ManualTests/org/eclipse/swt/tests/gtk/snippets/Bug573697_MenuBar_MenuLeak.java

@@ -23,8 +23,8 @@
 import org.eclipse.swt.widgets.Shell;
 
 /**
- * Description: In bug 573697, we observed a native memory leak cased by {@link Decorations#accelGroup}
- * not being unreferenced.
+ * Description: In bug 573697, we observed a native memory leak caused in the GTK implementation of {@link Decorations}
+ * by the field {@code accelGroup} not being unreferenced.
  * <p>
  * Steps to reproduce:
  * </p>

tests/org.eclipse.swt.tests/ManualTests/org/eclipse/swt/tests/manual/Issue0445_HiDPISmoothScaling.java

@@ -42,9 +42,8 @@
  * <p>
  * On Linux you may need to run this with GDK_SCALE=2 set in the environment.
  *
- * @see <a href=
- *      "https://github.com/eclipse-platform/eclipse.platform.swt/issues/445">Issue
- *      #445</a> for details.
+ *
+ * For details see: {@code https://github.com/eclipse-platform/eclipse.platform.swt/issues/445}.
  */
 @SuppressWarnings("restriction")
 public class Issue0445_HiDPISmoothScaling {