Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlexander Kurtakov2015-03-09 20:38:50 +0000
committerAlexander Kurtakov2015-03-09 20:57:29 +0000
commit5bf9b435e70358ca8c62e62ae0cb6b5bb011dc23 (patch)
tree6b7c8a748f3fb86acc348ea29bcbe42592c2cc77
parentc4a278817e3beebe0a61b19bf3d2699fbb43b406 (diff)
downloadorg.eclipse.linuxtools-5bf9b435e70358ca8c62e62ae0cb6b5bb011dc23.tar.gz
org.eclipse.linuxtools-5bf9b435e70358ca8c62e62ae0cb6b5bb011dc23.tar.xz
org.eclipse.linuxtools-5bf9b435e70358ca8c62e62ae0cb6b5bb011dc23.zip
dataviewers: Javadoc fixes.
Please Java 8 javadoc tool. Enable warnings to yell about these problems for the future. Change-Id: I53fababfc57bd2ce5a1ebca85fd696478f118f92 Signed-off-by: Alexander Kurtakov <akurtako@redhat.com> Reviewed-on: https://git.eclipse.org/r/43475 Tested-by: Hudson CI
-rw-r--r--profiling/org.eclipse.linuxtools.dataviewers.charts/.settings/org.eclipse.jdt.core.prefs10
-rwxr-xr-xprofiling/org.eclipse.linuxtools.dataviewers.charts/src/org/eclipse/linuxtools/dataviewers/charts/provider/ChartFactory.java2
-rwxr-xr-xprofiling/org.eclipse.linuxtools.dataviewers.charts/src/org/eclipse/linuxtools/dataviewers/charts/provider/IChartField.java2
-rwxr-xr-xprofiling/org.eclipse.linuxtools.dataviewers.charts/src/org/eclipse/linuxtools/internal/dataviewers/charts/dialogs/ChartDialog.java6
-rwxr-xr-xprofiling/org.eclipse.linuxtools.dataviewers.charts/src/org/eclipse/linuxtools/internal/dataviewers/charts/view/ChartView.java5
5 files changed, 14 insertions, 11 deletions
diff --git a/profiling/org.eclipse.linuxtools.dataviewers.charts/.settings/org.eclipse.jdt.core.prefs b/profiling/org.eclipse.linuxtools.dataviewers.charts/.settings/org.eclipse.jdt.core.prefs
index 71f5b5bfff..993ee24e74 100644
--- a/profiling/org.eclipse.linuxtools.dataviewers.charts/.settings/org.eclipse.jdt.core.prefs
+++ b/profiling/org.eclipse.linuxtools.dataviewers.charts/.settings/org.eclipse.jdt.core.prefs
@@ -50,11 +50,11 @@ 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.missingJavadocTagsVisibility=public
+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=default
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.dataviewers.charts/src/org/eclipse/linuxtools/dataviewers/charts/provider/ChartFactory.java b/profiling/org.eclipse.linuxtools.dataviewers.charts/src/org/eclipse/linuxtools/dataviewers/charts/provider/ChartFactory.java
index b3adc45dfd..dab79d38df 100755
--- a/profiling/org.eclipse.linuxtools.dataviewers.charts/src/org/eclipse/linuxtools/dataviewers/charts/provider/ChartFactory.java
+++ b/profiling/org.eclipse.linuxtools.dataviewers.charts/src/org/eclipse/linuxtools/dataviewers/charts/provider/ChartFactory.java
@@ -45,6 +45,7 @@ public final class ChartFactory {
* the field used to get the labels of the objects (colored parts in the pie).
* @param valFields
* the field providing the values for the pie parts.
+ * @param title Title of the chart.
* @return a new pie chart
*/
public static Chart producePieChart(Object[] objects, ISTDataViewersField nameField,
@@ -106,6 +107,7 @@ public final class ChartFactory {
* the field used to get the labels of the objects (the labels of the series groups).
* @param valFields
* the fields providing the values for the different bars in a series group.
+ * @param title Title of the chart.
* @param horizontal
* if true the bars are displayed horizontally, else vertically.
* @return a new 2D bar chart
diff --git a/profiling/org.eclipse.linuxtools.dataviewers.charts/src/org/eclipse/linuxtools/dataviewers/charts/provider/IChartField.java b/profiling/org.eclipse.linuxtools.dataviewers.charts/src/org/eclipse/linuxtools/dataviewers/charts/provider/IChartField.java
index f1bf64bac2..9578b53918 100755
--- a/profiling/org.eclipse.linuxtools.dataviewers.charts/src/org/eclipse/linuxtools/dataviewers/charts/provider/IChartField.java
+++ b/profiling/org.eclipse.linuxtools.dataviewers.charts/src/org/eclipse/linuxtools/dataviewers/charts/provider/IChartField.java
@@ -20,7 +20,7 @@ public interface IChartField extends ISTDataViewersField {
/**
* Returns the number to display in the chart for this object.
*
- * @param obj
+ * @param obj The field to retrieve from.
* @return the corresponding number value
*/
Number getNumber(Object obj);
diff --git a/profiling/org.eclipse.linuxtools.dataviewers.charts/src/org/eclipse/linuxtools/internal/dataviewers/charts/dialogs/ChartDialog.java b/profiling/org.eclipse.linuxtools.dataviewers.charts/src/org/eclipse/linuxtools/internal/dataviewers/charts/dialogs/ChartDialog.java
index 6a25dd8703..0ff2002410 100755
--- a/profiling/org.eclipse.linuxtools.dataviewers.charts/src/org/eclipse/linuxtools/internal/dataviewers/charts/dialogs/ChartDialog.java
+++ b/profiling/org.eclipse.linuxtools.dataviewers.charts/src/org/eclipse/linuxtools/internal/dataviewers/charts/dialogs/ChartDialog.java
@@ -77,10 +77,10 @@ public class ChartDialog extends Dialog {
private List<Button> columnButtons;
/**
- * The constructor
+ * The constructor.
*
- * @param shell
- * @param stViewer
+ * @param shell Parent shell.
+ * @param stViewer The viewer this dialog fetch data from.
*/
public ChartDialog(Shell shell, AbstractSTViewer stViewer) {
super(shell);
diff --git a/profiling/org.eclipse.linuxtools.dataviewers.charts/src/org/eclipse/linuxtools/internal/dataviewers/charts/view/ChartView.java b/profiling/org.eclipse.linuxtools.dataviewers.charts/src/org/eclipse/linuxtools/internal/dataviewers/charts/view/ChartView.java
index 92c0d18f5f..4627acf256 100755
--- a/profiling/org.eclipse.linuxtools.dataviewers.charts/src/org/eclipse/linuxtools/internal/dataviewers/charts/view/ChartView.java
+++ b/profiling/org.eclipse.linuxtools.dataviewers.charts/src/org/eclipse/linuxtools/internal/dataviewers/charts/view/ChartView.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2009 STMicroelectronics.
+ * Copyright (c) 2009, 2015 STMicroelectronics.
* 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:
* Marzia Maugeri <marzia.maugeri@st.com> - initial API and implementation
+ * Red Hat Inc. - ongoing maintenance
*******************************************************************************/
package org.eclipse.linuxtools.internal.dataviewers.charts.view;
@@ -53,7 +54,7 @@ public class ChartView extends ViewPart {
* thread execution is synchronized on internal Integer SEC_ID which is the secondary id of the chart view. Each new
* chart view has a secondary id equal to SEC_ID++.
*
- * @param chart
+ * @param chart The chart to create view for.
*/
public static void createChartView(final Chart chart) {
PlatformUI.getWorkbench().getDisplay().syncExec(new Runnable() {

Back to the top