From 44e0370d769cb607a6e5428e269e1faade4c6c25 Mon Sep 17 00:00:00 2001 From: Sergey Prigogin Date: Mon, 14 Mar 2016 18:05:22 -0700 Subject: [PATCH] Marked deprecated APIs with @noreference tags to be able to remove them later. Change-Id: I7ca0a396d3080c30d8dad70717d85bb0b973b01a --- .../dialogs/cpaths/IContainerDescriptor.java | 7 +++-- .../cpaths/IncludesSymbolsPropertyPage.java | 31 +++++++++---------- .../eclipse/cdt/ui/IEditorInputDelegate.java | 7 ++--- .../cdt/ui/dialogs/ICOptionContainer.java | 3 -- .../eclipse/cdt/ui/dialogs/IndexerBlock.java | 1 + .../ui/dialogs/IndexerOptionPropertyPage.java | 3 +- .../contentassist/ICompletionContributor.java | 3 +- .../cdt/ui/wizards/ICPathContainerPage.java | 7 ++--- .../ui/wizards/IPathEntryContainerPage.java | 23 +++----------- 9 files changed, 32 insertions(+), 53 deletions(-) diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/dialogs/cpaths/IContainerDescriptor.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/dialogs/cpaths/IContainerDescriptor.java index cd3dcb2e001..01375d8fba5 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/dialogs/cpaths/IContainerDescriptor.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/dialogs/cpaths/IContainerDescriptor.java @@ -10,18 +10,19 @@ *******************************************************************************/ package org.eclipse.cdt.internal.ui.dialogs.cpaths; -import org.eclipse.cdt.core.model.IPathEntry; -import org.eclipse.cdt.ui.wizards.IPathEntryContainerPage; import org.eclipse.core.runtime.CoreException; import org.eclipse.swt.graphics.Image; +import org.eclipse.cdt.core.model.IPathEntry; +import org.eclipse.cdt.ui.wizards.IPathEntryContainerPage; + /** * @deprecated as of CDT 4.0. This class was used for property pages * for 3.X style projects. + * @noreference This interface is not intended to be referenced by clients. */ @Deprecated public interface IContainerDescriptor { - public IPathEntryContainerPage createPage() throws CoreException; public String getName(); public Image getImage(); diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/dialogs/cpaths/IncludesSymbolsPropertyPage.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/dialogs/cpaths/IncludesSymbolsPropertyPage.java index 48dd1e5819c..66195c72327 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/dialogs/cpaths/IncludesSymbolsPropertyPage.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/internal/ui/dialogs/cpaths/IncludesSymbolsPropertyPage.java @@ -12,17 +12,6 @@ package org.eclipse.cdt.internal.ui.dialogs.cpaths; import java.lang.reflect.InvocationTargetException; -import org.eclipse.cdt.core.CProjectNature; -import org.eclipse.cdt.core.model.CModelException; -import org.eclipse.cdt.core.model.CoreModel; -import org.eclipse.cdt.core.model.ICElement; -import org.eclipse.cdt.core.resources.IPathEntryStore; -import org.eclipse.cdt.core.resources.IPathEntryStoreListener; -import org.eclipse.cdt.core.resources.PathEntryStoreChangedEvent; -import org.eclipse.cdt.internal.ui.dialogs.IStatusChangeListener; -import org.eclipse.cdt.internal.ui.dialogs.StatusUtil; -import org.eclipse.cdt.internal.ui.util.ExceptionHandler; -import org.eclipse.cdt.ui.CUIPlugin; import org.eclipse.core.resources.IProject; import org.eclipse.core.resources.IResource; import org.eclipse.core.runtime.CoreException; @@ -42,17 +31,25 @@ import org.eclipse.swt.widgets.Shell; import org.eclipse.ui.actions.WorkspaceModifyDelegatingOperation; import org.eclipse.ui.dialogs.PropertyPage; +import org.eclipse.cdt.core.CProjectNature; +import org.eclipse.cdt.core.model.CModelException; +import org.eclipse.cdt.core.model.CoreModel; +import org.eclipse.cdt.core.model.ICElement; +import org.eclipse.cdt.core.resources.IPathEntryStore; +import org.eclipse.cdt.core.resources.IPathEntryStoreListener; +import org.eclipse.cdt.core.resources.PathEntryStoreChangedEvent; +import org.eclipse.cdt.ui.CUIPlugin; + +import org.eclipse.cdt.internal.ui.dialogs.IStatusChangeListener; +import org.eclipse.cdt.internal.ui.dialogs.StatusUtil; +import org.eclipse.cdt.internal.ui.util.ExceptionHandler; + /** - * C/C++ Include Paths and Symbols page for 3.X projects. - * - * This page lives dormant as of writing (CDT 7.0) but may get activated for - * {@code org.eclipse.cdt.make.core.makeNature} project (3.X style). - * * @deprecated as of CDT 4.0. + * @noreference This class is not intended to be referenced by clients. */ @Deprecated public class IncludesSymbolsPropertyPage extends PropertyPage implements IStatusChangeListener, IPathEntryStoreListener { - private static final String PAGE_SETTINGS = "IncludeSysmbolsPropertyPage"; //$NON-NLS-1$ private static final String INDEX = "pageIndex"; //$NON-NLS-1$ diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IEditorInputDelegate.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IEditorInputDelegate.java index bcbc06810e4..b6bef54df40 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IEditorInputDelegate.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IEditorInputDelegate.java @@ -8,7 +8,6 @@ * Contributors: * QNX Software Systems - Initial API and implementation *******************************************************************************/ - package org.eclipse.cdt.ui; import org.eclipse.core.resources.IStorage; @@ -16,10 +15,8 @@ import org.eclipse.core.runtime.CoreException; import org.eclipse.ui.IEditorInput; /** - * This interface allows to create flexible editor inputs. - * - * @since May 21, 2003 * @deprecated Not supported anymore. + * @noreference This interface is not intended to be referenced by clients. */ @Deprecated public interface IEditorInputDelegate extends IEditorInput { @@ -33,7 +30,7 @@ public interface IEditorInputDelegate extends IEditorInput { /** * Returns the storage associated with this editor input. * - * @return stirage associated with this editor input + * @return storage associated with this editor input * @throws CoreException on failure. Reasons include: */ IStorage getStorage() throws CoreException; diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/dialogs/ICOptionContainer.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/dialogs/ICOptionContainer.java index bee008752cc..dfcff5ade0f 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/dialogs/ICOptionContainer.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/dialogs/ICOptionContainer.java @@ -10,12 +10,10 @@ *******************************************************************************/ package org.eclipse.cdt.ui.dialogs; - import org.eclipse.core.resources.IProject; import org.eclipse.core.runtime.Preferences; public interface ICOptionContainer { - void updateContainer(); IProject getProject(); @@ -26,5 +24,4 @@ public interface ICOptionContainer { * @return the preference store, or null if none */ public Preferences getPreferences(); - } diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/dialogs/IndexerBlock.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/dialogs/IndexerBlock.java index 744cb6cb2fa..e4d60a15c61 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/dialogs/IndexerBlock.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/dialogs/IndexerBlock.java @@ -604,6 +604,7 @@ public class IndexerBlock extends AbstractCOptionPage { /** * @deprecated always returns false + * @noreference This method is not intended to be referenced by clients. */ @Deprecated public boolean isIndexEnabled() { diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/dialogs/IndexerOptionPropertyPage.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/dialogs/IndexerOptionPropertyPage.java index d1ead96f76e..24f747b67b2 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/dialogs/IndexerOptionPropertyPage.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/dialogs/IndexerOptionPropertyPage.java @@ -83,7 +83,8 @@ public class IndexerOptionPropertyPage extends PropertyPage implements ICOptionC } /** - * @deprecated + * @deprecated Throws UnsupportedOperationException if called. + * @noreference This method is not intended to be referenced by clients. */ @Override @Deprecated diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/contentassist/ICompletionContributor.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/contentassist/ICompletionContributor.java index 9bed2c9a558..b4407becbab 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/contentassist/ICompletionContributor.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/contentassist/ICompletionContributor.java @@ -24,8 +24,7 @@ import org.eclipse.cdt.core.model.IWorkingCopy; * @deprecated Clients should extend the new extension point * completionProprosalComputer and implement interface * {@link ICompletionProposalComputer} - * @noextend This interface is not intended to be extended by clients. - * @noimplement This interface is not intended to be implemented by clients. + * @noreference This interface is not intended to be referenced by clients. */ @Deprecated public interface ICompletionContributor { diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/wizards/ICPathContainerPage.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/wizards/ICPathContainerPage.java index cfba826f8ac..ffcae99f068 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/wizards/ICPathContainerPage.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/wizards/ICPathContainerPage.java @@ -10,9 +10,10 @@ *******************************************************************************/ package org.eclipse.cdt.ui.wizards; +import org.eclipse.jface.wizard.IWizardPage; + import org.eclipse.cdt.core.model.ICProject; import org.eclipse.cdt.core.model.IPathEntry; -import org.eclipse.jface.wizard.IWizardPage; /** * A path container page allows the user to create a new or edit an @@ -29,10 +30,8 @@ import org.eclipse.jface.wizard.IWizardPage; *

* * @deprecated - use IPathEntryContainerPage - * @noextend This interface is not intended to be extended by clients. - * @noimplement This interface is not intended to be implemented by clients. + * @noreference This interface is not intended to be referenced by clients. */ - @Deprecated public interface ICPathContainerPage extends IWizardPage { diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/wizards/IPathEntryContainerPage.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/wizards/IPathEntryContainerPage.java index 41a9454667a..9d6e1ac640e 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/wizards/IPathEntryContainerPage.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/wizards/IPathEntryContainerPage.java @@ -10,32 +10,19 @@ *******************************************************************************/ package org.eclipse.cdt.ui.wizards; +import org.eclipse.jface.wizard.IWizardPage; + import org.eclipse.cdt.core.model.ICProject; import org.eclipse.cdt.core.model.IContainerEntry; import org.eclipse.cdt.core.model.IPathEntry; -import org.eclipse.jface.wizard.IWizardPage; /** - * A path container page allows the user to create a new or edit an - * existing patch container entry. - *

- * Clients should implement this interface and include the name of their - * class in an extension contributed to the cdt.ui's path container page - * extension point (named org.eclipse.cdt.ui.pathContainerPage - * ). - *

- *

- * Clients implementing this interface may subclass from - * org.eclipse.jface.wizard.WizardPage. - *

- * * @deprecated as of CDT 4.0. This tab was used to set preferences/properties * for 3.X style projects. + * @noreference This interface is not intended to be referenced by clients. */ - @Deprecated public interface IPathEntryContainerPage extends IWizardPage { - /** * Method initialize() is called before ICPathContainerPage.setSelection * to give additional information about the context the path container entry is configured in. This information @@ -54,7 +41,7 @@ public interface IPathEntryContainerPage extends IWizardPage { * store the page result (new/changed path entry returned in * getSelection) into its model. * - * @return if the operation was succesful. Only when returned + * @return if the operation was successful. Only when returned * true, the wizard will close. */ public boolean finish(); @@ -70,7 +57,7 @@ public interface IPathEntryContainerPage extends IWizardPage { * if a new entry should be created. * * @param containerEntry the path entry to edit or null. - * If unequals null then the path entry must be of + * If not equals null then the path entry must be of * kind IPathEntry.CDT_CONTAINER */ public void setSelection(IContainerEntry containerEntry);