1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-08-08 16:55:38 +02:00

Marked deprecated APIs with @noreference tags to be able to remove them

later.

Change-Id: I7ca0a396d3080c30d8dad70717d85bb0b973b01a
This commit is contained in:
Sergey Prigogin 2016-03-14 18:05:22 -07:00 committed by Gerrit Code Review @ Eclipse.org
parent 3199dc91bf
commit 44e0370d76
9 changed files with 32 additions and 53 deletions

View file

@ -10,18 +10,19 @@
*******************************************************************************/ *******************************************************************************/
package org.eclipse.cdt.internal.ui.dialogs.cpaths; 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.core.runtime.CoreException;
import org.eclipse.swt.graphics.Image; 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 * @deprecated as of CDT 4.0. This class was used for property pages
* for 3.X style projects. * for 3.X style projects.
* @noreference This interface is not intended to be referenced by clients.
*/ */
@Deprecated @Deprecated
public interface IContainerDescriptor { public interface IContainerDescriptor {
public IPathEntryContainerPage createPage() throws CoreException; public IPathEntryContainerPage createPage() throws CoreException;
public String getName(); public String getName();
public Image getImage(); public Image getImage();

View file

@ -12,17 +12,6 @@ package org.eclipse.cdt.internal.ui.dialogs.cpaths;
import java.lang.reflect.InvocationTargetException; 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.IProject;
import org.eclipse.core.resources.IResource; import org.eclipse.core.resources.IResource;
import org.eclipse.core.runtime.CoreException; 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.actions.WorkspaceModifyDelegatingOperation;
import org.eclipse.ui.dialogs.PropertyPage; 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. * @deprecated as of CDT 4.0.
* @noreference This class is not intended to be referenced by clients.
*/ */
@Deprecated @Deprecated
public class IncludesSymbolsPropertyPage extends PropertyPage implements IStatusChangeListener, IPathEntryStoreListener { public class IncludesSymbolsPropertyPage extends PropertyPage implements IStatusChangeListener, IPathEntryStoreListener {
private static final String PAGE_SETTINGS = "IncludeSysmbolsPropertyPage"; //$NON-NLS-1$ private static final String PAGE_SETTINGS = "IncludeSysmbolsPropertyPage"; //$NON-NLS-1$
private static final String INDEX = "pageIndex"; //$NON-NLS-1$ private static final String INDEX = "pageIndex"; //$NON-NLS-1$

View file

@ -8,7 +8,6 @@
* Contributors: * Contributors:
* QNX Software Systems - Initial API and implementation * QNX Software Systems - Initial API and implementation
*******************************************************************************/ *******************************************************************************/
package org.eclipse.cdt.ui; package org.eclipse.cdt.ui;
import org.eclipse.core.resources.IStorage; import org.eclipse.core.resources.IStorage;
@ -16,10 +15,8 @@ import org.eclipse.core.runtime.CoreException;
import org.eclipse.ui.IEditorInput; import org.eclipse.ui.IEditorInput;
/** /**
* This interface allows to create flexible editor inputs.
*
* @since May 21, 2003
* @deprecated Not supported anymore. * @deprecated Not supported anymore.
* @noreference This interface is not intended to be referenced by clients.
*/ */
@Deprecated @Deprecated
public interface IEditorInputDelegate extends IEditorInput { public interface IEditorInputDelegate extends IEditorInput {
@ -33,7 +30,7 @@ public interface IEditorInputDelegate extends IEditorInput {
/** /**
* Returns the storage associated with this editor input. * 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: * @throws CoreException on failure. Reasons include:
*/ */
IStorage getStorage() throws CoreException; IStorage getStorage() throws CoreException;

View file

@ -10,12 +10,10 @@
*******************************************************************************/ *******************************************************************************/
package org.eclipse.cdt.ui.dialogs; package org.eclipse.cdt.ui.dialogs;
import org.eclipse.core.resources.IProject; import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.Preferences; import org.eclipse.core.runtime.Preferences;
public interface ICOptionContainer { public interface ICOptionContainer {
void updateContainer(); void updateContainer();
IProject getProject(); IProject getProject();
@ -26,5 +24,4 @@ public interface ICOptionContainer {
* @return the preference store, or <code>null</code> if none * @return the preference store, or <code>null</code> if none
*/ */
public Preferences getPreferences(); public Preferences getPreferences();
} }

View file

@ -604,6 +604,7 @@ public class IndexerBlock extends AbstractCOptionPage {
/** /**
* @deprecated always returns false * @deprecated always returns false
* @noreference This method is not intended to be referenced by clients.
*/ */
@Deprecated @Deprecated
public boolean isIndexEnabled() { public boolean isIndexEnabled() {

View file

@ -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 @Override
@Deprecated @Deprecated

View file

@ -24,8 +24,7 @@ import org.eclipse.cdt.core.model.IWorkingCopy;
* @deprecated Clients should extend the new extension point * @deprecated Clients should extend the new extension point
* <tt>completionProprosalComputer</tt> and implement interface * <tt>completionProprosalComputer</tt> and implement interface
* {@link ICompletionProposalComputer} * {@link ICompletionProposalComputer}
* @noextend This interface is not intended to be extended by clients. * @noreference This interface is not intended to be referenced by clients.
* @noimplement This interface is not intended to be implemented by clients.
*/ */
@Deprecated @Deprecated
public interface ICompletionContributor { public interface ICompletionContributor {

View file

@ -10,9 +10,10 @@
*******************************************************************************/ *******************************************************************************/
package org.eclipse.cdt.ui.wizards; 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.ICProject;
import org.eclipse.cdt.core.model.IPathEntry; 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 * A path container page allows the user to create a new or edit an
@ -29,10 +30,8 @@ import org.eclipse.jface.wizard.IWizardPage;
* </p> * </p>
* *
* @deprecated - use IPathEntryContainerPage * @deprecated - use IPathEntryContainerPage
* @noextend This interface is not intended to be extended by clients. * @noreference This interface is not intended to be referenced by clients.
* @noimplement This interface is not intended to be implemented by clients.
*/ */
@Deprecated @Deprecated
public interface ICPathContainerPage extends IWizardPage { public interface ICPathContainerPage extends IWizardPage {

View file

@ -10,32 +10,19 @@
*******************************************************************************/ *******************************************************************************/
package org.eclipse.cdt.ui.wizards; 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.ICProject;
import org.eclipse.cdt.core.model.IContainerEntry; import org.eclipse.cdt.core.model.IContainerEntry;
import org.eclipse.cdt.core.model.IPathEntry; 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.
* <p>
* 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 <code>org.eclipse.cdt.ui.pathContainerPage
* </code>).
* </p>
* <p>
* Clients implementing this interface may subclass from
* <code>org.eclipse.jface.wizard.WizardPage</code>.
* </p>
*
* @deprecated as of CDT 4.0. This tab was used to set preferences/properties * @deprecated as of CDT 4.0. This tab was used to set preferences/properties
* for 3.X style projects. * for 3.X style projects.
* @noreference This interface is not intended to be referenced by clients.
*/ */
@Deprecated @Deprecated
public interface IPathEntryContainerPage extends IWizardPage { public interface IPathEntryContainerPage extends IWizardPage {
/** /**
* Method <code>initialize()</code> is called before <code>ICPathContainerPage.setSelection</code> * Method <code>initialize()</code> is called before <code>ICPathContainerPage.setSelection</code>
* to give additional information about the context the path container entry is configured in. This information * 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 * store the page result (new/changed path entry returned in
* getSelection) into its model. * getSelection) into its model.
* *
* @return if the operation was succesful. Only when returned * @return if the operation was successful. Only when returned
* <code>true</code>, the wizard will close. * <code>true</code>, the wizard will close.
*/ */
public boolean finish(); public boolean finish();
@ -70,7 +57,7 @@ public interface IPathEntryContainerPage extends IWizardPage {
* if a new entry should be created. * if a new entry should be created.
* *
* @param containerEntry the path entry to edit or <code>null</code>. * @param containerEntry the path entry to edit or <code>null</code>.
* If unequals <code>null</code> then the path entry must be of * If not equals <code>null</code> then the path entry must be of
* kind <code>IPathEntry.CDT_CONTAINER</code> * kind <code>IPathEntry.CDT_CONTAINER</code>
*/ */
public void setSelection(IContainerEntry containerEntry); public void setSelection(IContainerEntry containerEntry);