From 8d1a04485c1330a0808c8d1e69b88130670fdf7a Mon Sep 17 00:00:00 2001 From: Alexander Kurtakov Date: Mon, 9 Mar 2015 22:57:04 +0200 Subject: systemtap: Javadoc fixes. Complains about javadoc for unused methods has been fixed by removing these methods and the underlying infrastructure. Bumped major to reflect API change. Change-Id: If7eec8d77f0ec8e854d1f1c56f573efd25dfd85d Signed-off-by: Alexander Kurtakov Reviewed-on: https://git.eclipse.org/r/43477 Tested-by: Hudson CI --- .../.settings/org.eclipse.jdt.core.prefs | 10 ++--- .../META-INF/MANIFEST.MF | 2 +- .../pom.xml | 2 +- .../systemtap/graphing/ui/charts/BarChart.java | 2 +- .../systemtap/graphing/ui/GraphDisplaySet.java | 35 +++------------ .../graphing/ui/views/GraphSelectorEditor.java | 50 ---------------------- .../ui/views/GraphSelectorEditorInput.java | 2 + .../graphing/ui/widgets/GraphComposite.java | 7 ++- .../ui/wizards/dataset/DataSetFactory.java | 4 ++ .../graphing/ui/wizards/graph/GraphFactory.java | 6 +++ .../structures/listeners/ITabListener.java | 18 -------- 11 files changed, 30 insertions(+), 108 deletions(-) delete mode 100644 systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/listeners/ITabListener.java diff --git a/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/.settings/org.eclipse.jdt.core.prefs b/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/.settings/org.eclipse.jdt.core.prefs index c1c016e20c..811feac942 100644 --- a/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/.settings/org.eclipse.jdt.core.prefs +++ b/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/.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/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/META-INF/MANIFEST.MF b/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/META-INF/MANIFEST.MF index 3f25f70f13..617aab389b 100644 --- a/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/META-INF/MANIFEST.MF +++ b/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/META-INF/MANIFEST.MF @@ -2,7 +2,7 @@ Manifest-Version: 1.0 Bundle-ManifestVersion: 2 Bundle-Name: %bundleName Bundle-SymbolicName: org.eclipse.linuxtools.systemtap.graphing.ui;singleton:=true -Bundle-Version: 3.2.0.qualifier +Bundle-Version: 4.0.0.qualifier Bundle-Activator: org.eclipse.linuxtools.internal.systemtap.graphing.ui.GraphingUIPlugin Bundle-Vendor: %bundleProvider Bundle-Localization: plugin diff --git a/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/pom.xml b/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/pom.xml index 10d6c50f37..b0f0e172f9 100644 --- a/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/pom.xml +++ b/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/pom.xml @@ -18,7 +18,7 @@ org.eclipse.linuxtools.systemtap.graphing.ui - 3.2.0-SNAPSHOT + 4.0.0-SNAPSHOT eclipse-plugin Linux Tools SystemTap Graphing UI Plug-In diff --git a/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/src/org/eclipse/linuxtools/internal/systemtap/graphing/ui/charts/BarChart.java b/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/src/org/eclipse/linuxtools/internal/systemtap/graphing/ui/charts/BarChart.java index a5b635fc64..684a38a12d 100644 --- a/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/src/org/eclipse/linuxtools/internal/systemtap/graphing/ui/charts/BarChart.java +++ b/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/src/org/eclipse/linuxtools/internal/systemtap/graphing/ui/charts/BarChart.java @@ -54,7 +54,7 @@ public class BarChart extends Chart { * cut off if there isn't enough room to display them fully. Use this * instead of accessing the chart's x-axis and setting its category * series directly. - * @param series + * @param series The category series. */ public void setCategorySeries(String[] series) { xAxis.setCategorySeries(series); diff --git a/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/src/org/eclipse/linuxtools/systemtap/graphing/ui/GraphDisplaySet.java b/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/src/org/eclipse/linuxtools/systemtap/graphing/ui/GraphDisplaySet.java index e609e0e262..f791631714 100644 --- a/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/src/org/eclipse/linuxtools/systemtap/graphing/ui/GraphDisplaySet.java +++ b/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/src/org/eclipse/linuxtools/systemtap/graphing/ui/GraphDisplaySet.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.graphing.ui; @@ -33,7 +34,6 @@ import org.eclipse.linuxtools.systemtap.graphing.ui.wizards.dataset.DataSetFacto import org.eclipse.linuxtools.systemtap.graphing.ui.wizards.graph.GraphFactory; import org.eclipse.linuxtools.systemtap.graphing.ui.wizards.graph.SelectGraphAndSeriesWizard; import org.eclipse.linuxtools.systemtap.structures.UpdateManager; -import org.eclipse.linuxtools.systemtap.structures.listeners.ITabListener; import org.eclipse.swt.SWT; import org.eclipse.swt.custom.CTabFolder; import org.eclipse.swt.custom.CTabFolder2Adapter; @@ -57,7 +57,6 @@ import org.eclipse.ui.plugin.AbstractUIPlugin; /** * This class is used to contain all of the graphing components that can * be displayed as individual tabs in a single location. - * @author Ryan Morse * @since 3.0 Migrated from .ui.graphing package. */ public class GraphDisplaySet { @@ -66,6 +65,9 @@ public class GraphDisplaySet { private IPreferenceStore p; /** + * Creates the display set. + * @param parent Parent composite. + * @param data The data set. * @since 3.0 set must be a IFilteredDataSet. */ public GraphDisplaySet(Composite parent, IFilteredDataSet data) { @@ -87,7 +89,6 @@ public class GraphDisplaySet { p.addPropertyChangeListener(propertyChangeListener); builders = new ArrayList<>(); - tabListeners = new ArrayList<>(); } /** @@ -134,7 +135,6 @@ public class GraphDisplaySet { updater.removeUpdateListener(builders.get(selected)); } builders.remove(selected); - fireTabCloseEvent(); } }); @@ -230,32 +230,8 @@ public class GraphDisplaySet { addGraph(gd); } wizard.dispose(); - fireTabOpenEvent(); } lastSelectedTab = folder.getSelectionIndex(); - fireTabChangedEvent(); - } - } - - public void addTabListener(ITabListener listener) { - tabListeners.add(listener); - } - - private void fireTabCloseEvent() { - for(int i=0; i tabListeners; private List builders; } diff --git a/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/src/org/eclipse/linuxtools/systemtap/graphing/ui/views/GraphSelectorEditor.java b/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/src/org/eclipse/linuxtools/systemtap/graphing/ui/views/GraphSelectorEditor.java index 397c085ee5..afb5c1fa0d 100644 --- a/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/src/org/eclipse/linuxtools/systemtap/graphing/ui/views/GraphSelectorEditor.java +++ b/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/src/org/eclipse/linuxtools/systemtap/graphing/ui/views/GraphSelectorEditor.java @@ -18,7 +18,6 @@ import org.eclipse.core.runtime.IProgressMonitor; import org.eclipse.linuxtools.internal.systemtap.graphing.ui.views.Messages; import org.eclipse.linuxtools.systemtap.graphing.core.datasets.IFilteredDataSet; import org.eclipse.linuxtools.systemtap.graphing.ui.GraphDisplaySet; -import org.eclipse.linuxtools.systemtap.structures.listeners.ITabListener; import org.eclipse.osgi.util.NLS; import org.eclipse.swt.SWT; import org.eclipse.swt.custom.CTabFolder; @@ -27,8 +26,6 @@ import org.eclipse.swt.custom.CTabFolderEvent; import org.eclipse.swt.custom.CTabItem; import org.eclipse.swt.events.DisposeEvent; import org.eclipse.swt.events.DisposeListener; -import org.eclipse.swt.events.SelectionAdapter; -import org.eclipse.swt.events.SelectionEvent; import org.eclipse.swt.layout.FormAttachment; import org.eclipse.swt.layout.FormData; import org.eclipse.swt.layout.FormLayout; @@ -51,13 +48,11 @@ public class GraphSelectorEditor extends EditorPart { private CTabFolder scriptFolder; private List displaySets; - private List tabListeners; public static final String ID = "org.eclipse.linuxtools.systemtap.graphing.ui.views.GraphSelectorEditor"; //$NON-NLS-1$ public GraphSelectorEditor() { super(); displaySets = new ArrayList<>(); - tabListeners = new ArrayList<>(); } /** @@ -88,7 +83,6 @@ public class GraphSelectorEditor extends EditorPart { } scriptFolder.setSelection(item); // Choose the last created item. - fireTabOpenEvent(); this.setPartName(NLS.bind(Messages.GraphSelectorEditor_graphsEditorTitle, scriptName.substring(scriptName.lastIndexOf('/')+1))); } @@ -117,19 +111,11 @@ public class GraphSelectorEditor extends EditorPart { data.right = new FormAttachment(100, 0); data.bottom = new FormAttachment(100, 0); scriptFolder.setLayoutData(data); - scriptFolder.addSelectionListener(new SelectionAdapter() { - @Override - public void widgetSelected(SelectionEvent e) { - fireTabChangedEvent(); - } - }); - scriptFolder.addCTabFolder2Listener(new CTabFolder2Adapter() { @Override public void close(CTabFolderEvent e) { displaySets.remove(scriptFolder.indexOf((CTabItem)e.item)); - fireTabCloseEvent(); } }); @@ -172,38 +158,6 @@ public class GraphSelectorEditor extends EditorPart { // Empty } - /** - * @since 2.0 - */ - public void addTabListener(ITabListener listener) { - tabListeners.add(listener); - } - - /** - * @since 2.0 - */ - public void removeTabListener(ITabListener listener) { - tabListeners.remove(listener); - } - - private void fireTabCloseEvent() { - for(ITabListener tabListener:tabListeners) { - tabListener.tabClosed(); - } - } - - private void fireTabOpenEvent() { - for(ITabListener tabListener:tabListeners) { - tabListener.tabOpened(); - } - } - - private void fireTabChangedEvent() { - for(ITabListener tabListener:tabListeners) { - tabListener.tabChanged(); - } - } - /** * Removes all internal references in this class. Nothing should make any references * to anything in this class after calling the dispose method. @@ -216,10 +170,6 @@ public class GraphSelectorEditor extends EditorPart { scriptFolder.dispose(); } scriptFolder = null; - if(null != tabListeners) { - tabListeners.clear(); - } - tabListeners = null; } @Override diff --git a/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/src/org/eclipse/linuxtools/systemtap/graphing/ui/views/GraphSelectorEditorInput.java b/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/src/org/eclipse/linuxtools/systemtap/graphing/ui/views/GraphSelectorEditorInput.java index b121971ee3..a0c4491f77 100644 --- a/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/src/org/eclipse/linuxtools/systemtap/graphing/ui/views/GraphSelectorEditorInput.java +++ b/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/src/org/eclipse/linuxtools/systemtap/graphing/ui/views/GraphSelectorEditorInput.java @@ -28,6 +28,8 @@ public class GraphSelectorEditorInput implements IEditorInput { } /** + * Creates the editor input with the given title. + * @param scriptTitle The title. * @since 2.2 */ public GraphSelectorEditorInput(String scriptTitle) { diff --git a/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/src/org/eclipse/linuxtools/systemtap/graphing/ui/widgets/GraphComposite.java b/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/src/org/eclipse/linuxtools/systemtap/graphing/ui/widgets/GraphComposite.java index edf6bd147e..f2c4aa9ce0 100644 --- a/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/src/org/eclipse/linuxtools/systemtap/graphing/ui/widgets/GraphComposite.java +++ b/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/src/org/eclipse/linuxtools/systemtap/graphing/ui/widgets/GraphComposite.java @@ -32,8 +32,6 @@ import org.eclipse.swt.widgets.Display; /** * A Composite type to contain a Graph object. - * @author Henry Hughes - * @author Ryan Morse */ public class GraphComposite extends Composite { @@ -48,6 +46,10 @@ public class GraphComposite extends Composite { /** * The default constructor: creates an internal composite for the Graph to render on, asks GraphFactory * to create the graph from the given GraphData and DataSet, then initializes all buttons and listeners. + * @param parent Parent composite. + * @param style Style of the widget to create + * @param gd Graph information. + * @param ds Data set for the graph. */ public GraphComposite(Composite parent, int style, GraphData gd, IDataSet ds) { super(parent, style); @@ -124,6 +126,7 @@ public class GraphComposite extends Composite { /** * Returns the graph that is rendering to this composite. + * @return The AbstractChartBuilder to put data into. */ public AbstractChartBuilder getCanvas() { return builder; diff --git a/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/src/org/eclipse/linuxtools/systemtap/graphing/ui/wizards/dataset/DataSetFactory.java b/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/src/org/eclipse/linuxtools/systemtap/graphing/ui/wizards/dataset/DataSetFactory.java index 041b8f7264..2effc63c80 100644 --- a/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/src/org/eclipse/linuxtools/systemtap/graphing/ui/wizards/dataset/DataSetFactory.java +++ b/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/src/org/eclipse/linuxtools/systemtap/graphing/ui/wizards/dataset/DataSetFactory.java @@ -40,6 +40,10 @@ public final class DataSetFactory { } /** + * Returns DataGrid instance containing the given data set as a sibling of the composite. + * @param composite The parent composite. + * @param set The data set. + * @return The DataGrid instance created. * @since 3.0 set must be a IFilteredDataSet. */ public static DataGrid getDataGrid(Composite composite, IFilteredDataSet set) { diff --git a/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/src/org/eclipse/linuxtools/systemtap/graphing/ui/wizards/graph/GraphFactory.java b/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/src/org/eclipse/linuxtools/systemtap/graphing/ui/wizards/graph/GraphFactory.java index 1f770677a1..ca2f95c7b1 100644 --- a/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/src/org/eclipse/linuxtools/systemtap/graphing/ui/wizards/graph/GraphFactory.java +++ b/systemtap/org.eclipse.linuxtools.systemtap.graphing.ui/src/org/eclipse/linuxtools/systemtap/graphing/ui/wizards/graph/GraphFactory.java @@ -161,6 +161,9 @@ public final class GraphFactory { } /** + * @param comp Parent composite. + * @param style Style of widget to create. + * @return The newly created X axis control. * @since 3.0 */ public static final Composite createGraphXControl(GraphComposite comp, int style) { @@ -172,6 +175,9 @@ public final class GraphFactory { } /** + * @param comp Parent composite. + * @param style Style of widget to create. + * @return The newly created Y axis control * @since 3.0 */ public static final Composite createGraphYControl(GraphComposite comp, int style) { diff --git a/systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/listeners/ITabListener.java b/systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/listeners/ITabListener.java deleted file mode 100644 index 71dd09e356..0000000000 --- a/systemtap/org.eclipse.linuxtools.systemtap.structures/src/org/eclipse/linuxtools/systemtap/structures/listeners/ITabListener.java +++ /dev/null @@ -1,18 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2006 IBM Corporation. - * 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 - * http://www.eclipse.org/legal/epl-v10.html - * - * Contributors: - * IBM Corporation - Jeff Briggs, Henry Hughes, Ryan Morse - *******************************************************************************/ - -package org.eclipse.linuxtools.systemtap.structures.listeners; - -public interface ITabListener { - void tabOpened(); - void tabClosed(); - void tabChanged(); -} -- cgit v1.2.3