Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlexander Kurtakov2015-03-06 18:56:25 +0000
committerAlexander Kurtakov2015-03-06 19:11:45 +0000
commit980315b60c1c118d639ee920ab5e8459e4155622 (patch)
treec56f4c7a74cb8517149eef0de3d75b3c73eb9647
parent76b4292e2bb7834d7edddba25bd3ff5b17b56e4b (diff)
downloadorg.eclipse.linuxtools-980315b60c1c118d639ee920ab5e8459e4155622.tar.gz
org.eclipse.linuxtools-980315b60c1c118d639ee920ab5e8459e4155622.tar.xz
org.eclipse.linuxtools-980315b60c1c118d639ee920ab5e8459e4155622.zip
systemtap: Fix javadoc in consolelog bundle.
In preparation for building with Java 8 fix javadoc warnings. Enable warnings for these issues. Change-Id: I327d64af23c288e1177853be4d25aa891d96815c Signed-off-by: Alexander Kurtakov <akurtako@redhat.com> Reviewed-on: https://git.eclipse.org/r/43334 Tested-by: Hudson CI
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/.settings/org.eclipse.jdt.core.prefs12
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/internal/systemtap/ui/consolelog/actions/SaveLogAction.java11
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/internal/systemtap/ui/consolelog/actions/StopScriptAction.java2
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/systemtap/ui/consolelog/ScpClient.java3
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/systemtap/ui/consolelog/ScpExec.java7
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/systemtap/ui/consolelog/internal/ConsoleLogPlugin.java1
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/systemtap/ui/consolelog/structures/ErrorStreamDaemon.java5
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/systemtap/ui/consolelog/structures/ScriptConsole.java10
8 files changed, 39 insertions, 12 deletions
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/.settings/org.eclipse.jdt.core.prefs b/systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/.settings/org.eclipse.jdt.core.prefs
index dddd8dff3b..673331d80a 100644
--- a/systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/.settings/org.eclipse.jdt.core.prefs
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/.settings/org.eclipse.jdt.core.prefs
@@ -6,8 +6,13 @@ org.eclipse.jdt.core.compiler.annotation.nonnullbydefault=org.eclipse.jdt.annota
org.eclipse.jdt.core.compiler.annotation.nullable=org.eclipse.jdt.annotation.Nullable
org.eclipse.jdt.core.compiler.annotation.nullanalysis=disabled
org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled
+org.eclipse.jdt.core.compiler.codegen.methodParameters=do not generate
org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.7
+org.eclipse.jdt.core.compiler.codegen.unusedLocal=preserve
org.eclipse.jdt.core.compiler.compliance=1.7
+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.annotationSuperInterface=warning
org.eclipse.jdt.core.compiler.problem.assertIdentifier=error
@@ -47,9 +52,9 @@ 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=ignore
-org.eclipse.jdt.core.compiler.problem.missingJavadocTagsMethodTypeParameters=disabled
-org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=disabled
+org.eclipse.jdt.core.compiler.problem.missingJavadocTags=warning
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagsMethodTypeParameters=enabled
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=enabled
org.eclipse.jdt.core.compiler.problem.missingJavadocTagsVisibility=public
org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotation=warning
org.eclipse.jdt.core.compiler.problem.missingOverrideAnnotationForInterfaceMethodImplementation=enabled
@@ -94,6 +99,7 @@ org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownException=warning
org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownExceptionExemptExceptionAndThrowable=disabled
org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownExceptionIncludeDocCommentReference=disabled
org.eclipse.jdt.core.compiler.problem.unusedDeclaredThrownExceptionWhenOverriding=enabled
+org.eclipse.jdt.core.compiler.problem.unusedExceptionParameter=ignore
org.eclipse.jdt.core.compiler.problem.unusedImport=warning
org.eclipse.jdt.core.compiler.problem.unusedLabel=warning
org.eclipse.jdt.core.compiler.problem.unusedLocal=warning
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/internal/systemtap/ui/consolelog/actions/SaveLogAction.java b/systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/internal/systemtap/ui/consolelog/actions/SaveLogAction.java
index 034e03ba93..0978203966 100644
--- a/systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/internal/systemtap/ui/consolelog/actions/SaveLogAction.java
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/internal/systemtap/ui/consolelog/actions/SaveLogAction.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2006 IBM Corporation and others.
+ * Copyright (c) 2006, 2015 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
@@ -27,22 +27,23 @@ import org.eclipse.ui.PlatformUI;
/**
* This class is used to allow the user to save the log generated from an active console
- * @author Ryan Morse
*/
public class SaveLogAction extends ConsoleAction implements ScriptConsoleObserver {
private String logFileName = null;
/**
+ * Creates the action for the given script console.
+ * @param consoleParam The console which log is to be saved.
* @since 2.0
*/
- public SaveLogAction(ScriptConsole fConsole) {
- super(fConsole,
+ public SaveLogAction(ScriptConsole consoleParam) {
+ super(consoleParam,
ConsoleLogPlugin.getDefault().getBundle().getEntry("icons/actions/save_log.gif"), //$NON-NLS-1$
Localization.getString("action.saveLog.name"), //$NON-NLS-1$
Localization.getString("action.saveLog.desc"), //$NON-NLS-1$
IAction.AS_CHECK_BOX);
- console.addScriptConsoleObserver(this);
+ consoleParam.addScriptConsoleObserver(this);
}
/**
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/internal/systemtap/ui/consolelog/actions/StopScriptAction.java b/systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/internal/systemtap/ui/consolelog/actions/StopScriptAction.java
index 4472905ef8..42a52b5265 100644
--- a/systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/internal/systemtap/ui/consolelog/actions/StopScriptAction.java
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/internal/systemtap/ui/consolelog/actions/StopScriptAction.java
@@ -43,6 +43,8 @@ public class StopScriptAction extends ConsoleAction implements ScriptConsoleObse
}
/**
+ * Creates the action for the given console.
+ * @param fConsole The console which will be stoppable.
* @since 2.0
*/
public StopScriptAction(ScriptConsole fConsole) {
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/systemtap/ui/consolelog/ScpClient.java b/systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/systemtap/ui/consolelog/ScpClient.java
index cf085ae356..38444360e7 100644
--- a/systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/systemtap/ui/consolelog/ScpClient.java
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/systemtap/ui/consolelog/ScpClient.java
@@ -30,6 +30,9 @@ public class ScpClient {
private Session session;
/**
+ * Creates ScpClient with given options.
+ * @param remoteOptions Connection properties.
+ * @throws JSchException If connection problem occurred.
* @since 3.0
*/
public ScpClient(RemoteScriptOptions remoteOptions) throws JSchException {
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/systemtap/ui/consolelog/ScpExec.java b/systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/systemtap/ui/consolelog/ScpExec.java
index 6e5d81b2e9..8ff2e29276 100644
--- a/systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/systemtap/ui/consolelog/ScpExec.java
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/systemtap/ui/consolelog/ScpExec.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2010 IBM Corporation.
+ * Copyright (c) 2010, 2015 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
@@ -7,6 +7,7 @@
*
* Contributors:
* IBM Corporation - initial API and implementation
+ * Red Hat Inc. - ongoing maintenance
*******************************************************************************/
package org.eclipse.linuxtools.systemtap.ui.consolelog;
@@ -34,6 +35,10 @@ public class ScpExec extends Command {
private RemoteScriptOptions remoteOptions;
/**
+ * Creates the exec helper class
+ * @param cmd The command to run.
+ * @param remoteOptions Remote connection information.
+ * @param envVars Runtime environment properties.
* @since 3.0
*/
public ScpExec(String[] cmd, RemoteScriptOptions remoteOptions, String[] envVars) {
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/systemtap/ui/consolelog/internal/ConsoleLogPlugin.java b/systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/systemtap/ui/consolelog/internal/ConsoleLogPlugin.java
index 04a976839e..67f85a3161 100644
--- a/systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/systemtap/ui/consolelog/internal/ConsoleLogPlugin.java
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/systemtap/ui/consolelog/internal/ConsoleLogPlugin.java
@@ -45,6 +45,7 @@ public class ConsoleLogPlugin extends AbstractUIPlugin {
/**
* Returns the shared instance.
+ * @return The bundle activator.
*/
public static ConsoleLogPlugin getDefault() {
return plugin;
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/systemtap/ui/consolelog/structures/ErrorStreamDaemon.java b/systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/systemtap/ui/consolelog/structures/ErrorStreamDaemon.java
index da9ebc5a34..f0ed8176a9 100644
--- a/systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/systemtap/ui/consolelog/structures/ErrorStreamDaemon.java
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/systemtap/ui/consolelog/structures/ErrorStreamDaemon.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2006 IBM Corporation.
+ * Copyright (c) 2006, 2015 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
@@ -7,6 +7,7 @@
*
* Contributors:
* IBM Corporation - Jeff Briggs, Henry Hughes, Ryan Morse
+ * Red Hat Inc. - ongoing maintenance
*******************************************************************************/
package org.eclipse.linuxtools.systemtap.ui.consolelog.structures;
@@ -15,7 +16,7 @@ import org.eclipse.linuxtools.systemtap.ui.consolelog.internal.Localization;
import org.eclipse.linuxtools.systemtap.ui.consolelog.views.ErrorView;
/**
- * A class push data to both the </code>ScriptConsole</code> and the ErrorView
+ * A class push data to both the <code>ScriptConsole</code> and the ErrorView
* @author Ryan Morse
*/
public class ErrorStreamDaemon extends ConsoleStreamDaemon {
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/systemtap/ui/consolelog/structures/ScriptConsole.java b/systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/systemtap/ui/consolelog/structures/ScriptConsole.java
index a608eef6cb..49f72f4152 100644
--- a/systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/systemtap/ui/consolelog/structures/ScriptConsole.java
+++ b/systemtap/org.eclipse.linuxtools.systemtap.ui.consolelog/src/org/eclipse/linuxtools/systemtap/ui/consolelog/structures/ScriptConsole.java
@@ -77,6 +77,9 @@ public class ScriptConsole extends IOConsole {
*/
public interface ScriptConsoleObserver {
/**
+ * Notifying observer of state change.
+ * @param started If the action is started or not.
+ * @param stopped If the action is stopped or not.
* @since 3.0
*/
void runningStateChanged(boolean started, boolean stopped);
@@ -112,7 +115,7 @@ public class ScriptConsole extends IOConsole {
* is already a console that has the same name as that provided it will be stopped,
* cleared and returned to the caller to use. If there is no console matching the
* provided name then a new <code>ScriptConsole</code> will be created for use.
- * @param name The name of the console that should be created & returned.
+ * @param name The name of the console that should be created &amp; returned.
* @return A console of the specified name.
*/
public synchronized static ScriptConsole getInstance(String name) {
@@ -428,6 +431,9 @@ public class ScriptConsole extends IOConsole {
}
/**
+ * Add observer to the script console.
+ *
+ * @param observer The observer to be added.
* @since 2.0
*/
public synchronized void addScriptConsoleObserver(ScriptConsoleObserver observer) {
@@ -436,6 +442,8 @@ public class ScriptConsole extends IOConsole {
}
/**
+ * Removes observer from the script console.
+ * @param observer The observer to be removed.
* @since 3.0
*/
public synchronized void removeScriptConsoleObserver(ScriptConsoleObserver observer) {

Back to the top