profiling.launch: Improve javadoc.

Fix warnings, parameters, etc.

Change-Id: Ifc2a7554331a6370c1ff59aecb56a3c74f2f9b88
Signed-off-by: Alexander Kurtakov <akurtako@redhat.com>
Reviewed-on: https://git.eclipse.org/r/25991
Tested-by: Hudson CI

11 files changed, 59 insertions, 23 deletions

diff --git a/profiling/org.eclipse.linuxtools.profiling.launch.ui.rdt.proxy/.settings/org.eclipse.jdt.core.prefs b/profiling/org.eclipse.linuxtools.profiling.launch.ui.rdt.proxy/.settings/org.eclipse.jdt.core.prefs
index 37db8e0cf9..fe74b0b683 100644
--- a/profiling/org.eclipse.linuxtools.profiling.launch.ui.rdt.proxy/.settings/org.eclipse.jdt.core.prefs
+++ b/profiling/org.eclipse.linuxtools.profiling.launch.ui.rdt.proxy/.settings/org.eclipse.jdt.core.prefs
@@ -8,6 +8,7 @@ org.eclipse.jdt.core.compiler.annotation.nullanalysis=disabled
 org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled
 org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.7
 org.eclipse.jdt.core.compiler.compliance=1.7
+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
 org.eclipse.jdt.core.compiler.problem.autoboxing=ignore
@@ -31,12 +32,25 @@ org.eclipse.jdt.core.compiler.problem.includeNullInfoFromAsserts=disabled
 org.eclipse.jdt.core.compiler.problem.incompatibleNonInheritedInterfaceMethod=warning
 org.eclipse.jdt.core.compiler.problem.incompleteEnumSwitch=warning
 org.eclipse.jdt.core.compiler.problem.indirectStaticAccess=warning
+org.eclipse.jdt.core.compiler.problem.invalidJavadoc=warning
+org.eclipse.jdt.core.compiler.problem.invalidJavadocTags=enabled
+org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsDeprecatedRef=disabled
+org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsNotVisibleRef=disabled
+org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsVisibility=private
 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=warning
+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=enabled
+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
diff --git a/profiling/org.eclipse.linuxtools.profiling.launch/.settings/org.eclipse.jdt.core.prefs b/profiling/org.eclipse.linuxtools.profiling.launch/.settings/org.eclipse.jdt.core.prefs
index b882c0776f..a7a1b6f9cd 100644
--- a/profiling/org.eclipse.linuxtools.profiling.launch/.settings/org.eclipse.jdt.core.prefs
+++ b/profiling/org.eclipse.linuxtools.profiling.launch/.settings/org.eclipse.jdt.core.prefs
@@ -40,7 +40,7 @@ org.eclipse.jdt.core.compiler.problem.invalidJavadoc=warning
 org.eclipse.jdt.core.compiler.problem.invalidJavadocTags=enabled
 org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsDeprecatedRef=disabled
 org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsNotVisibleRef=disabled
-org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsVisibility=protected
+org.eclipse.jdt.core.compiler.problem.invalidJavadocTagsVisibility=private
 org.eclipse.jdt.core.compiler.problem.localVariableHiding=ignore
 org.eclipse.jdt.core.compiler.problem.methodWithConstructorName=warning
 org.eclipse.jdt.core.compiler.problem.missingDefaultCase=ignore
diff --git a/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/internal/profiling/launch/AbstractProfilingOptionsTab.java b/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/internal/profiling/launch/AbstractProfilingOptionsTab.java
index 62f899ff8d..41ea28f85a 100644
--- a/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/internal/profiling/launch/AbstractProfilingOptionsTab.java
+++ b/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/internal/profiling/launch/AbstractProfilingOptionsTab.java
@@ -220,8 +220,7 @@ public abstract class AbstractProfilingOptionsTab extends AbstractLaunchConfigur
 
     /**
      * Set the provider attribute in the specified configuration.
-     *
-     * @param configuration a configuration
+     * @param providerId The new provider id.
      */
     private void setProvider(String providerId) {
         try {
@@ -310,15 +309,15 @@ public abstract class AbstractProfilingOptionsTab extends AbstractLaunchConfigur
     }
 
     /**
-     * Get index of specific name in the combo items list
+     * Get index of specific name in the combo items list.
      *
-     * @param name name of item
-     * @return index of given name, -1 if it not found
+     * @param name Name of item
+     * @return Index of given name, -1 if it not found.
      */
-    private int getItemIndex(Combo combo, String name) {
-        int itemCount = combo.getItemCount();
+    private int getItemIndex(String name) {
+        int itemCount = providerCombo.getItemCount();
         for (int i = 0; i < itemCount; i++) {
-            if (combo.getItem(i).equals(name)) {
+            if (providerCombo.getItem(i).equals(name)) {
                 return i;
             }
         }
@@ -333,7 +332,7 @@ public abstract class AbstractProfilingOptionsTab extends AbstractLaunchConfigur
      */
     private int getComboItemIndexFromId(String id) {
         String providerName = getComboItemNameFromId(id);
-        return getItemIndex(providerCombo, providerName);
+        return getItemIndex(providerName);
     }
 
     @Override
diff --git a/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/internal/profiling/launch/ProfileLaunchPlugin.java b/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/internal/profiling/launch/ProfileLaunchPlugin.java
index 042423fbba..a99d3c1368 100644
--- a/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/internal/profiling/launch/ProfileLaunchPlugin.java
+++ b/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/internal/profiling/launch/ProfileLaunchPlugin.java
@@ -37,6 +37,7 @@ public class ProfileLaunchPlugin extends AbstractUIPlugin {
 
     /**
      * Convenience method which returns the unique identifier of this plugin.
+     * @return The identifier.
      * @since 1.1
      */
     public static String getUniqueIdentifier() {
diff --git a/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/internal/profiling/launch/provider/launch/ProviderFramework.java b/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/internal/profiling/launch/provider/launch/ProviderFramework.java
index cf809d2e6a..5dc7491bb9 100644
--- a/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/internal/profiling/launch/provider/launch/ProviderFramework.java
+++ b/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/internal/profiling/launch/provider/launch/ProviderFramework.java
@@ -289,6 +289,8 @@ public class ProviderFramework {
      * extensions of the
      * <code>org.eclipse.linuxtools.profiling.launch.launchProvider</code>
      * extensions point.
+     * @param id
+     * @return The name of the tool if found.
      *
      * @since 2.0
      */
@@ -310,6 +312,7 @@ public class ProviderFramework {
      * with id <code>toolId</code>.
      *
      * @param toolId String unique id of the tool.
+     * @param attribute
      * @return String description of tool.
      * @since 2.0
      */
@@ -456,6 +459,7 @@ public class ProviderFramework {
      * it will look for the provider with the highest priority for the specified type.
      * If this fails, it will look for the default provider.
      *
+     * @param wc
      * @param type a profiling type
      * @return a provider id that contributes to the specified type
      * @since 2.0
diff --git a/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/profiling/launch/IRemoteCommandLauncher.java b/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/profiling/launch/IRemoteCommandLauncher.java
index b92a62686e..7c54f6d14c 100644
--- a/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/profiling/launch/IRemoteCommandLauncher.java
+++ b/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/profiling/launch/IRemoteCommandLauncher.java
@@ -25,6 +25,14 @@ public interface IRemoteCommandLauncher {
 
     Process execute(IPath commandPath, String[] args, String[] env, IPath changeToDirectory, IProgressMonitor monitor) throws CoreException;
     /**
+     * @param commandPath
+     * @param args
+     * @param env
+     * @param changeToDirectory
+     * @param monitor
+     * @param pty
+     * @return  The executed process
+     * @throws CoreException
      * @since 3.0
      */
     Process execute(IPath commandPath, String[] args, String[] env, IPath changeToDirectory, IProgressMonitor monitor, PTY pty) throws CoreException;
diff --git a/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/profiling/launch/ProfileLaunchShortcut.java b/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/profiling/launch/ProfileLaunchShortcut.java
index b15e277c7f..d7b856c470 100644
--- a/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/profiling/launch/ProfileLaunchShortcut.java
+++ b/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/profiling/launch/ProfileLaunchShortcut.java
@@ -75,8 +75,10 @@ public abstract class ProfileLaunchShortcut implements ILaunchShortcut {
 
     /**
      * Locate a configuration to relaunch for the given type.  If one cannot be found, create one.
+     * @param bin The binary to look launch for.
+     * @param mode
      *
-     * @return a re-useable config or <code>null</code> if none
+     * @return A re-useable config or <code>null</code> if none.
      */
     protected ILaunchConfiguration findLaunchConfiguration(IBinary bin, String mode) {
         ILaunchConfiguration configuration = null;
@@ -188,7 +190,7 @@ public abstract class ProfileLaunchShortcut implements ILaunchShortcut {
 
     /**
      * Method searchAndLaunch.
-     * @param objects
+     * @param elements
      * @param mode
      */
     private void searchAndLaunch(final Object[] elements, String mode) {
@@ -267,6 +269,8 @@ public abstract class ProfileLaunchShortcut implements ILaunchShortcut {
 
     /**
      * Prompts the user to select a  binary
+     * @param binList
+     * @param mode
      *
      * @return the selected binary or <code>null</code> if none.
      */
@@ -315,8 +319,10 @@ public abstract class ProfileLaunchShortcut implements ILaunchShortcut {
 
     /**
      * Show a selection dialog that allows the user to choose one of the specified
-     * launch configurations.  Return the chosen config, or <code>null</code> if the
-     * user cancelled the dialog.
+     * launch configurations.
+     * @param configList
+     * @param mode
+     * @return The chosen config, or <code>null</code> if the user cancelled the dialog.
      */
     protected ILaunchConfiguration chooseConfiguration(List<ILaunchConfiguration> configList, String mode) {
         IDebugModelPresentation labelProvider = DebugUITools.newDebugModelPresentation();
diff --git a/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/profiling/launch/RemoteProxyCMainTab.java b/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/profiling/launch/RemoteProxyCMainTab.java
index 2908ebde17..ad28530393 100644
--- a/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/profiling/launch/RemoteProxyCMainTab.java
+++ b/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/profiling/launch/RemoteProxyCMainTab.java
@@ -1042,7 +1042,9 @@ public class RemoteProxyCMainTab extends CAbstractMainTab {
 
     /**
      * Set the program name attributes on the working copy based on the
-     * ICElement
+     * ICElement.
+     * @param cElement
+     * @param config
      */
     protected void initializeProgramName(ICElement cElement,
             ILaunchConfigurationWorkingCopy config) {
diff --git a/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/profiling/launch/RemoteProxyManager.java b/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/profiling/launch/RemoteProxyManager.java
index 11c58c2f23..3a382e76bb 100644
--- a/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/profiling/launch/RemoteProxyManager.java
+++ b/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/profiling/launch/RemoteProxyManager.java
@@ -61,6 +61,9 @@ public class RemoteProxyManager implements IRemoteProxyManager {
         return lfp;
     }
     /**
+     * @param schemeId
+     * @return The {@link IRemoteProxyManager} for the given scheme.
+     * @throws CoreException
      * @since 2.1
      */
     protected IRemoteProxyManager getRemoteManager(String schemeId) throws CoreException {
@@ -166,7 +169,9 @@ public class RemoteProxyManager implements IRemoteProxyManager {
      * of pure remote and sync projects. Synchronized projects
      * have a cached path and a remote one, and this method
      * returns the remote one.
-     * @return string containing the project location
+     * @param project
+     * @return The project location.
+     * @throws CoreException
      * @since 2.2
      */
     public String getRemoteProjectLocation(IProject project) throws CoreException {
diff --git a/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/profiling/launch/ui/FileSystemSelectionArea.java b/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/profiling/launch/ui/FileSystemSelectionArea.java
index ca8eef0285..959a0b5e7b 100755
--- a/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/profiling/launch/ui/FileSystemSelectionArea.java
+++ b/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/profiling/launch/ui/FileSystemSelectionArea.java
@@ -185,9 +185,10 @@ public class FileSystemSelectionArea {
     }
 
     /**
-     * Set the filesystem selection combo box to the specified scheme.  If the scheme isn't
-     * legal, throw a CoreException.
+     * Set the filesystem selection combo box to the specified scheme.
+     *
      * @param scheme name of scheme, e.g. "rse"
+     * @throws CoreException If scheme is illegal.
      */
     public void setSelectedFileSystem(String scheme) throws CoreException {
         Iterator<FileSystemElement> fsEltItr = fsElements.iterator();
diff --git a/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/profiling/launch/ui/ResourceSelectorWidget.java b/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/profiling/launch/ui/ResourceSelectorWidget.java
index 9a01c032b1..a0a8055d55 100644
--- a/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/profiling/launch/ui/ResourceSelectorWidget.java
+++ b/profiling/org.eclipse.linuxtools.profiling.launch/src/org/eclipse/linuxtools/profiling/launch/ui/ResourceSelectorWidget.java
@@ -139,6 +139,7 @@ public class ResourceSelectorWidget {
      * Create the area for user entry.
      *
      * @param composite
+     * @param uriLabelText
      */
     private void createUserEntryArea(Composite composite, String uriLabelText) {
         // location label
@@ -182,11 +183,6 @@ public class ResourceSelectorWidget {
         });
 
         uriField.addModifyListener(new ModifyListener() {
-            /*
-             * (non-Javadoc)
-             *
-             * @see org.eclipse.swt.events.ModifyListener#modifyText(org.eclipse.swt.events.ModifyEvent)
-             */
             @Override
             public void modifyText(ModifyEvent e) {
                 updateFilesystemSelector(uriField.getText());