Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlexander Kurtakov2015-03-09 19:40:16 +0000
committerAlexander Kurtakov2015-03-09 19:57:38 +0000
commitfe00ea8bf79167ee994f3c4b2c7113203539f91d (patch)
tree45535bff1cbd2be0207acf09c742aac19bcba710
parentfb59b1eebb6e2bcb784f63e6507d64a92705dfac (diff)
downloadorg.eclipse.linuxtools-fe00ea8bf79167ee994f3c4b2c7113203539f91d.tar.gz
org.eclipse.linuxtools-fe00ea8bf79167ee994f3c4b2c7113203539f91d.tar.xz
org.eclipse.linuxtools-fe00ea8bf79167ee994f3c4b2c7113203539f91d.zip
systemtap: Fix javadoc.
Please Java 8 javadoc tool. Stricter javadoc settings to warn about this. Change-Id: I1c2a32a257ece92e743faa79e4ef39a9a01eb4e2 Signed-off-by: Alexander Kurtakov <akurtako@redhat.com> Reviewed-on: https://git.eclipse.org/r/43470 Tested-by: Hudson CI
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.structures/.settings/org.eclipse.jdt.core.prefs8
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/Copier.java5
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/KernelSourceTree.java2
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/TreeNode.java3
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/UpdateManager.java2
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/listeners/IGobblerListener.java1
-rw-r--r--systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/runnable/Command.java7
7 files changed, 19 insertions, 9 deletions
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.structures/.settings/org.eclipse.jdt.core.prefs b/systemtap/org.eclipse.linuxtools.systemtap.structures/.settings/org.eclipse.jdt.core.prefs
index 8976d4545b..5a84876f18 100644
--- a/systemtap/org.eclipse.linuxtools.systemtap.structures/.settings/org.eclipse.jdt.core.prefs
+++ b/systemtap/org.eclipse.linuxtools.systemtap.structures/.settings/org.eclipse.jdt.core.prefs
@@ -46,10 +46,10 @@ 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=ignore
-org.eclipse.jdt.core.compiler.problem.missingJavadocTagsMethodTypeParameters=disabled
-org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=disabled
+org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=all_standard_tags
+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
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/Copier.java b/systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/Copier.java
index 61c04fe0b0..1b6866a37b 100644
--- a/systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/Copier.java
+++ b/systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/Copier.java
@@ -18,6 +18,7 @@ public final class Copier {
/**
* Returns a copy of the passed in ArrayList array object.
+ * @param <T> The list type.
*
* @param list The ArrayList array object to copy.
*
@@ -28,14 +29,16 @@ public final class Copier {
@SuppressWarnings("unchecked")
List<T>[] list2 = new ArrayList[list.length];
- for(int i=0; i<list2.length; i++)
+ for(int i=0; i<list2.length; i++) {
list2[i] = copy(list[i]);
+ }
return list2;
}
/**
* Returns a copy of the passed in ArrayList object.
+ * @param <T> The list type.
*
* @param list The ArrayList object to copy.
*
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/KernelSourceTree.java b/systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/KernelSourceTree.java
index ce26d34327..cb55b2778d 100644
--- a/systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/KernelSourceTree.java
+++ b/systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/KernelSourceTree.java
@@ -58,7 +58,7 @@ public class KernelSourceTree {
* @param excluded The string array to store as excluded.
* @param proxy The proxy to be used to get the remote files
* @param monitor a progress monitor for this operation. Can be null.
- * @throws CoreException
+ * @throws CoreException If traversing the tree fails.
*
* @since 1.1
*/
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/TreeNode.java b/systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/TreeNode.java
index d130f5841b..e296d64d60 100644
--- a/systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/TreeNode.java
+++ b/systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/TreeNode.java
@@ -131,6 +131,9 @@ public class TreeNode {
}
/**
+ * Return the child nod with given name if found.
+ * @param name The name of the looked up child.
+ * @return The found TreeNode or null if not found.
* @since 2.0
*/
public TreeNode getChildByName(String name) {
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/UpdateManager.java b/systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/UpdateManager.java
index 00b58e01e2..452acc6582 100644
--- a/systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/UpdateManager.java
+++ b/systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/UpdateManager.java
@@ -29,6 +29,8 @@ public class UpdateManager {
}
/**
+ * Restart with the given delay.
+ * @param delay The milliseconds to delay execution.
* @since 3.0
*/
public void restart(int delay) {
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/listeners/IGobblerListener.java b/systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/listeners/IGobblerListener.java
index 8f9aff1c54..67d9d04c5a 100644
--- a/systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/listeners/IGobblerListener.java
+++ b/systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/listeners/IGobblerListener.java
@@ -15,6 +15,7 @@ public interface IGobblerListener {
/**
* called by streamgobbler when new data is present
+ * @param line The textual line to process.
*
*/
void handleDataEvent(String line);
diff --git a/systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/runnable/Command.java b/systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/runnable/Command.java
index eb006a1b98..eeb0fa715b 100644
--- a/systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/runnable/Command.java
+++ b/systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/runnable/Command.java
@@ -115,7 +115,7 @@ public class Command implements Runnable {
* Starts the <code>Thread</code> that the new <code>Process</code> will run in.
* This must be called in order to get the process to start running.
* Note that this method only takes effect the first time it is called.
- * @throws CoreException
+ * @throws CoreException If initializing failed.
*/
public void start() throws CoreException {
if (started || stopped) {
@@ -283,7 +283,7 @@ public class Command implements Runnable {
/**
* Removes the provided listener from those monitoring the InputStream.
- * @param listener An </code>IGobblerListener</code> that is monitoring the stream.
+ * @param listener An <code>IGobblerListener</code> that is monitoring the stream.
*/
public void removeInputStreamListener(IGobblerListener listener) {
if (inputGobbler != null) {
@@ -295,7 +295,7 @@ public class Command implements Runnable {
/**
* Removes the provided listener from those monitoring the ErrorStream.
- * @param listener An </code>IGobblerListener</code> that is monitoring the stream.
+ * @param listener An <code>IGobblerListener</code> that is monitoring the stream.
*/
public void removeErrorStreamListener(IGobblerListener listener) {
if (errorGobbler != null) {
@@ -309,6 +309,7 @@ public class Command implements Runnable {
* Saves the input stream data to a permanent file. Any new data on the
* stream will automatically be saved to the file.
* @param file The file to save the InputStream to.
+ * @return True if the save was successful, false otherwise.
*/
public boolean saveLog(File file) {
return logger.saveLog(file);

Back to the top