From 14790ea880107312bcc44e642a9d8d8b5b79de02 Mon Sep 17 00:00:00 2001 From: Anton Leherbauer Date: Thu, 18 Dec 2008 10:49:32 +0000 Subject: [PATCH] API Cleanup --- core/org.eclipse.cdt.ui/plugin.xml | 4 +- .../src/org/eclipse/cdt/ui/CDTUIImages.java | 5 ++- .../src/org/eclipse/cdt/ui/CUIPlugin.java | 37 ++++++++++++++++++- .../org/eclipse/cdt/ui/CodeGeneration.java | 2 + .../eclipse/cdt/ui/IBuildConsoleEvent.java | 9 ++++- .../eclipse/cdt/ui/IBuildConsoleListener.java | 10 ++++- .../eclipse/cdt/ui/IBuildConsoleManager.java | 3 ++ .../src/org/eclipse/cdt/ui/ICDTConstants.java | 6 ++- .../src/org/eclipse/cdt/ui/ICHelpBook.java | 5 ++- .../org/eclipse/cdt/ui/ICHelpProvider.java | 5 ++- .../cdt/ui/ICHelpResourceDescriptor.java | 5 ++- .../eclipse/cdt/ui/IEditorInputDelegate.java | 4 +- .../org/eclipse/cdt/ui/IFunctionSummary.java | 12 +++++- .../src/org/eclipse/cdt/ui/ILanguageUI.java | 11 ++++-- .../cdt/ui/IPropertyChangeParticipant.java | 3 ++ .../eclipse/cdt/ui/IWorkingCopyManager.java | 3 +- .../cdt/ui/IWorkingCopyManagerExtension.java | 1 + .../eclipse/cdt/ui/PreferenceConstants.java | 6 ++- .../cdt/ui/actions/CdtActionConstants.java | 1 + .../ui/actions/CustomFiltersActionGroup.java | 1 + .../cdt/ui/actions/GenerateActionGroup.java | 3 ++ .../ui/actions/MemberFilterActionGroup.java | 5 +++ .../eclipse/cdt/ui/actions/OpenAction.java | 2 + .../cdt/ui/actions/OpenViewActionGroup.java | 2 + .../ui/actions/SelectionDispatchAction.java | 3 +- .../cdt/ui/text/ICCompletionProposal.java | 5 ++- .../cdt/ui/text/ICHelpInvocationContext.java | 7 +++- .../org/eclipse/cdt/ui/text/ICPartitions.java | 2 + .../eclipse/cdt/ui/text/ICTokenScanner.java | 3 ++ .../cdt/ui/text/IInvocationContext.java | 2 + .../eclipse/cdt/ui/text/IProblemLocation.java | 3 ++ .../org/eclipse/cdt/ui/text/ITokenStore.java | 3 ++ .../cdt/ui/text/ITokenStoreFactory.java | 3 ++ .../org/eclipse/cdt/ui/text/TaskTagRule.java | 3 ++ ...CEditorContentAssistInvocationContext.java | 5 ++- .../ICompletionProposalComputer.java | 2 + .../text/contentassist/IProposalFilter.java | 29 +++++++++------ .../cdt/ui/wizards/NewFileCreationWizard.java | 4 ++ .../ui/wizards/NewFolderCreationWizard.java | 4 ++ 39 files changed, 186 insertions(+), 37 deletions(-) diff --git a/core/org.eclipse.cdt.ui/plugin.xml b/core/org.eclipse.cdt.ui/plugin.xml index c0b3f4dae45..dba24dbfcee 100644 --- a/core/org.eclipse.cdt.ui/plugin.xml +++ b/core/org.eclipse.cdt.ui/plugin.xml @@ -352,7 +352,7 @@ category="org.eclipse.cdt.ui.newCWizards" finalPerspective="org.eclipse.cdt.ui.CPerspective" id="org.eclipse.cdt.ui.wizards.NewFolderCreationWizard"> - + @@ -436,7 +436,7 @@ category="org.eclipse.cdt.ui.newCCWizards" finalPerspective="org.eclipse.cdt.ui.CPerspective" id="org.eclipse.cdt.ui.wizards.NewFolderCreationWizard"> - + diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/CDTUIImages.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/CDTUIImages.java index 3da1d693ce3..bd437ad9cbc 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/CDTUIImages.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/CDTUIImages.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2002, 2007 Rational Software Corporation and others. + * Copyright (c) 2002, 2008 Rational Software 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 @@ -22,6 +22,9 @@ import org.eclipse.swt.graphics.Image; /** * Bundle of all images used by the C plugin. + * + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. */ public class CDTUIImages { diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/CUIPlugin.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/CUIPlugin.java index d383be1ce2a..96f0d37aaa7 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/CUIPlugin.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/CUIPlugin.java @@ -98,6 +98,10 @@ import org.eclipse.cdt.internal.ui.util.ProblemMarkerManager; import org.eclipse.cdt.internal.ui.util.Util; import org.eclipse.cdt.internal.ui.viewsupport.CDTContextActivator; +/** + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. + */ public class CUIPlugin extends AbstractUIPlugin { public static final String PLUGIN_ID = "org.eclipse.cdt.ui"; //$NON-NLS-1$ @@ -135,7 +139,10 @@ public class CUIPlugin extends AbstractUIPlugin { /** * The id of the C hierarchy perspective * (value "org.eclipse.cdt.ui.CHierarchyPerspective"). + * + * @deprecated This perspective no longer exists. */ + @Deprecated public static final String ID_CHIERARCHY_PERSPECTIVE = PLUGIN_ID + ".CHierarchyPerspective"; //$NON-NLS-1$ /** @@ -143,7 +150,9 @@ public class CUIPlugin extends AbstractUIPlugin { * (value "org.eclipse.cdt.ui.CBrowsingPerspective"). * * @since 2.0 + * @deprecated This perspective no longer exists. */ + @Deprecated public static final String ID_CBROWSING_PERSPECTIVE = PLUGIN_ID + ".CBrowsingPerspective"; //$NON-NLS-1$ /** @@ -151,7 +160,9 @@ public class CUIPlugin extends AbstractUIPlugin { * (value "org.eclipse.cdt.ui.ProjectsView"). * * @since 2.0 + * @deprecated This view no longer exists. */ + @Deprecated public static String ID_PROJECTS_VIEW = PLUGIN_ID + ".ProjectsView"; //$NON-NLS-1$ /** @@ -159,7 +170,9 @@ public class CUIPlugin extends AbstractUIPlugin { * (value "org.eclipse.cdt.ui.NamespacesView"). * * @since 2.0 + * @deprecated This view no longer exists. */ + @Deprecated public static String ID_NAMESPACES_VIEW = PLUGIN_ID + ".NamespacesView"; //$NON-NLS-1$ /** @@ -167,7 +180,9 @@ public class CUIPlugin extends AbstractUIPlugin { * (value "org.eclipse.cdt.ui.TypesView"). * * @since 2.0 + * @deprecated This view no longer exists. */ + @Deprecated public static String ID_TYPES_VIEW = PLUGIN_ID + ".TypesView"; //$NON-NLS-1$ /** @@ -175,7 +190,9 @@ public class CUIPlugin extends AbstractUIPlugin { * (value "org.eclipse.cdt.ui.MembersView"). * * @since 2.0 + * @deprecated This view no longer exists. */ + @Deprecated public static String ID_MEMBERS_VIEW = PLUGIN_ID + ".MembersView"; //$NON-NLS-1$ /** @@ -216,6 +233,9 @@ public class CUIPlugin extends AbstractUIPlugin { } } + /** + * @noreference This method is not intended to be referenced by clients. + */ public synchronized IBufferFactory getBufferFactory() { if (fBufferFactory == null) fBufferFactory= new CustomBufferFactory(); @@ -399,7 +419,9 @@ public class CUIPlugin extends AbstractUIPlugin { } /** - * Returns the used document provider + * Returns the used document provider. + * + * @noreference This method is not intended to be referenced by clients. */ public synchronized CDocumentProvider getDocumentProvider() { if (fDocumentProvider == null) { @@ -563,6 +585,9 @@ public class CUIPlugin extends AbstractUIPlugin { return PLUGIN_ID; } + /** + * @noreference This method is not intended to be referenced by clients. + */ public static ImageDescriptorRegistry getImageDescriptorRegistry() { return getDefault().internalGetImageDescriptorRegistry(); } @@ -574,7 +599,9 @@ public class CUIPlugin extends AbstractUIPlugin { } /** - * Returns the problem marker manager + * Returns the problem marker manager. + * + * @noreference This method is not intended to be referenced by clients. */ public ProblemMarkerManager getProblemMarkerManager() { if (fProblemMarkerManager == null) @@ -710,6 +737,8 @@ public class CUIPlugin extends AbstractUIPlugin { * Returns all C editor text hovers contributed to the workbench. * * @return an array of CEditorTextHoverDescriptor + * + * @noreference This method is not intended to be referenced by clients. */ public CEditorTextHoverDescriptor[] getCEditorTextHoverDescriptors() { if (fCEditorTextHoverDescriptors == null) { @@ -806,6 +835,8 @@ public class CUIPlugin extends AbstractUIPlugin { * extension point. * * @return the registry of contributed ICFoldingStructureProvider + * + * @noreference This method is not intended to be referenced by clients. * @since 3.0 */ public synchronized CFoldingStructureProviderRegistry getFoldingStructureProviderRegistry() { @@ -893,6 +924,8 @@ public class CUIPlugin extends AbstractUIPlugin { * Returns the AST provider. * * @return the AST provider + * + * @noreference This method is not intended to be referenced by clients. * @since 4.0 */ public synchronized ASTProvider getASTProvider() { diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/CodeGeneration.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/CodeGeneration.java index 744f4d878a1..c1a22fa0ca4 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/CodeGeneration.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/CodeGeneration.java @@ -22,6 +22,8 @@ import org.eclipse.cdt.internal.corext.codemanipulation.StubUtility; /** * Class that offers access to the templates contained in the 'Code Templates' preference page. * + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. * @since 2.1 */ public class CodeGeneration { diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IBuildConsoleEvent.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IBuildConsoleEvent.java index 0fb5cca0ab7..de74ee59a0f 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IBuildConsoleEvent.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IBuildConsoleEvent.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 QNX Software Systems and others. + * Copyright (c) 2000, 2008 QNX Software Systems 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 @@ -12,6 +12,13 @@ package org.eclipse.cdt.ui; import org.eclipse.core.resources.IProject; +/** + * A build console event. + * + * @see IBuildConsoleListener + * + * @noimplement This interface is not intended to be implemented by clients. + */ public interface IBuildConsoleEvent { final static int CONSOLE_START = 1; final static int CONSOLE_CLOSE = 2; diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IBuildConsoleListener.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IBuildConsoleListener.java index eba6d3525cd..d9ddfdf8c8e 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IBuildConsoleListener.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IBuildConsoleListener.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 QNX Software Systems and others. + * Copyright (c) 2000, 2008 QNX Software Systems 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 @@ -10,6 +10,14 @@ *******************************************************************************/ package org.eclipse.cdt.ui; +/** + * A listener to build console events. + *

+ * Clients may implement this interface. + *

+ * + * @see IBuildConsoleEvent + */ public interface IBuildConsoleListener { void consoleChange(IBuildConsoleEvent event); } diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IBuildConsoleManager.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IBuildConsoleManager.java index 60f2bd36eff..43e65293dab 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IBuildConsoleManager.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IBuildConsoleManager.java @@ -14,6 +14,9 @@ import org.eclipse.cdt.core.resources.IConsole; import org.eclipse.core.resources.IProject; import org.eclipse.jface.text.IDocument; +/** + * @noimplement This interface is not intended to be implemented by clients. + */ public interface IBuildConsoleManager { IConsole getConsole(IProject project); IDocument getConsoleDocument(IProject project); diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/ICDTConstants.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/ICDTConstants.java index 7bca12b1a7a..2460dfc9c36 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/ICDTConstants.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/ICDTConstants.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 QNX Software Systems and others. + * Copyright (c) 2000, 2008 QNX Software Systems 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 @@ -11,6 +11,9 @@ package org.eclipse.cdt.ui; +/** + * @noimplement This interface is not intended to be implemented by clients. + */ public interface ICDTConstants { // CDT Extension Points @@ -25,4 +28,3 @@ public interface ICDTConstants public static final String ATT_NAME = "name"; //$NON-NLS-1$ public static final String ATT_PERSPECTIVE = "perspective"; //$NON-NLS-1$ } - diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/ICHelpBook.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/ICHelpBook.java index 2f6d0aeb440..2fcb4a03fde 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/ICHelpBook.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/ICHelpBook.java @@ -1,5 +1,5 @@ /********************************************************************** - * Copyright (c) 2004, 2005 Intel Corporation and others. + * Copyright (c) 2004, 2008 Intel 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 @@ -13,6 +13,9 @@ package org.eclipse.cdt.ui; /** * Represents the help book, that is a set of articles on some topic. * Such as "C functions", "Qt library", etc., provided by help provider. + *

+ * Clients may implement this interface. + *

* @see ICHelpProvider * @since 2.1 */ diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/ICHelpProvider.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/ICHelpProvider.java index d1a08b0f876..13a614084bc 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/ICHelpProvider.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/ICHelpProvider.java @@ -1,5 +1,5 @@ /********************************************************************** - * Copyright (c) 2004, 2005 Intel Corporation and others. + * Copyright (c) 2004, 2008 Intel 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 @@ -14,6 +14,9 @@ import org.eclipse.cdt.ui.text.ICHelpInvocationContext; /** * Represents the C/C++ help provider + *

+ * Clients may implement this interface. + *

* * @since 2.1 */ diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/ICHelpResourceDescriptor.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/ICHelpResourceDescriptor.java index 3274ba44993..69169e3e7da 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/ICHelpResourceDescriptor.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/ICHelpResourceDescriptor.java @@ -1,5 +1,5 @@ /********************************************************************** - * Copyright (c) 2004, 2005 Intel Corporation and others. + * Copyright (c) 2004, 2008 Intel 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 @@ -15,6 +15,9 @@ import org.eclipse.help.IHelpResource; /** * This interface represents Help Resources found in the certain Help Book * provided by certain CHelpProvider + *

+ * Clients may implement this interface. + *

* @see ICHelpProvider * @since 2.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 2c7a291132f..bcbc06810e4 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 @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 QNX Software Systems and others. + * Copyright (c) 2000, 2008 QNX Software Systems 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 @@ -19,7 +19,9 @@ import org.eclipse.ui.IEditorInput; * This interface allows to create flexible editor inputs. * * @since May 21, 2003 + * @deprecated Not supported anymore. */ +@Deprecated public interface IEditorInputDelegate extends IEditorInput { /** * Returns the editor input delegate for this editor input. diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IFunctionSummary.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IFunctionSummary.java index f56a0736e67..8de427cc0d0 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IFunctionSummary.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IFunctionSummary.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2006 QNX Software Systems and others. + * Copyright (c) 2000, 2008 QNX Software Systems 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 @@ -11,8 +11,18 @@ package org.eclipse.cdt.ui; +/** + *

+ * Clients may implement this interface. + *

+ */ public interface IFunctionSummary { + /** + *

+ * Clients may implement this interface. + *

+ */ public interface IFunctionPrototypeSummary { /** * Get the name of the function. This should be the diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/ILanguageUI.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/ILanguageUI.java index be8267197f5..12dcadeb6cf 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/ILanguageUI.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/ILanguageUI.java @@ -1,12 +1,12 @@ /********************************************************************** - * Copyright (c) 2006 QNX Software Systems and others. + * Copyright (c) 2006, 2008 QNX Software Systems 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 * http://www.eclipse.org/legal/epl-v10.html * * Contributors: - * QNX Software Systems - Initial API and implementation + * Doug Schaefer (QNX Software Systems) - Initial API and implementation **********************************************************************/ package org.eclipse.cdt.ui; @@ -15,8 +15,11 @@ import org.eclipse.core.runtime.IAdaptable; import org.eclipse.jface.text.rules.RuleBasedScanner; /** - * @author Doug Schaefer - * + * Adapter interface to {@link org.eclipse.cdt.core.model.ILanguage ILanguage} for language extensions to + * provide a custom code scanner implementation. + *

+ * Clients may implement this interface. + *

*/ public interface ILanguageUI extends IAdaptable { diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IPropertyChangeParticipant.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IPropertyChangeParticipant.java index f9163767425..71134baa8a9 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IPropertyChangeParticipant.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IPropertyChangeParticipant.java @@ -16,6 +16,9 @@ import org.eclipse.jface.util.PropertyChangeEvent; * Implemented by classes which can optionally participate in property * change events, and report whether an event would affect them without * adapting to it. + *

+ * Clients may implement this interface. + *

* * @since 5.0 */ diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IWorkingCopyManager.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IWorkingCopyManager.java index 62504bb4256..bba934d0a1c 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IWorkingCopyManager.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IWorkingCopyManager.java @@ -29,7 +29,8 @@ import org.eclipse.ui.IEditorInput; *

* This interface is not intended to be implemented by clients. *

- * + * @noimplement This interface is not intended to be implemented by clients. + * * @see CUIPlugin#getWorkingCopyManager */ public interface IWorkingCopyManager { diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IWorkingCopyManagerExtension.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IWorkingCopyManagerExtension.java index 23c33997ab2..77cefc89d67 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IWorkingCopyManagerExtension.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/IWorkingCopyManagerExtension.java @@ -16,6 +16,7 @@ import org.eclipse.ui.IEditorInput; /** * Extension interface for IWorkingCopyManager. + * @noimplement This interface is not intended to be implemented by clients. * @since 2.1 */ public interface IWorkingCopyManagerExtension { diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/PreferenceConstants.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/PreferenceConstants.java index ae4c8f9609f..c2917bc5fc4 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/PreferenceConstants.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/PreferenceConstants.java @@ -41,9 +41,11 @@ import org.eclipse.cdt.internal.ui.text.spelling.SpellCheckEngine; * Preference constants used in the CDT-UI preference store. Clients should only read the * CDT-UI preference store using these values. Clients are not allowed to modify the * preference store programmatically. - * + * + * @noextend This class is not intended to be subclassed by clients. + * @noinstantiate This class is not intended to be instantiated by clients. * @since 2.0 - */ + */ public class PreferenceConstants { private PreferenceConstants() { diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/actions/CdtActionConstants.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/actions/CdtActionConstants.java index 4168772e5ce..581802495de 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/actions/CdtActionConstants.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/actions/CdtActionConstants.java @@ -18,6 +18,7 @@ package org.eclipse.cdt.ui.actions; * This class may be instantiated; it is not intended to be subclassed. *

* + * @noextend This class is not intended to be subclassed by clients. * @since 2.0 */ public class CdtActionConstants { diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/actions/CustomFiltersActionGroup.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/actions/CustomFiltersActionGroup.java index 3c989d1159b..a5dcd316eb3 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/actions/CustomFiltersActionGroup.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/actions/CustomFiltersActionGroup.java @@ -65,6 +65,7 @@ import org.eclipse.cdt.internal.ui.filters.NamePatternFilter; * This class may be instantiated; it is not intended to be subclassed. *

* + * @noextend This class is not intended to be subclassed by clients. * @since 2.0 */ public class CustomFiltersActionGroup extends ActionGroup { diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/actions/GenerateActionGroup.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/actions/GenerateActionGroup.java index 20db7e97660..7a54e79c526 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/actions/GenerateActionGroup.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/actions/GenerateActionGroup.java @@ -51,6 +51,7 @@ import org.eclipse.cdt.internal.ui.editor.ICEditorActionDefinitionIds; * This class may be instantiated; it is not intended to be subclassed. *

* + * @noextend This class is not intended to be subclassed by clients. * @since 4.0 */ public class GenerateActionGroup extends ActionGroup { @@ -137,6 +138,8 @@ public class GenerateActionGroup extends ActionGroup { * Note: This constructor is for internal use only. Clients should not call this constructor. * @param editor the C editor * @param groupName the group name to add the action to + * + * @noreference This constructor is not intended to be referenced by clients. */ public GenerateActionGroup(CEditor editor, String groupName) { fSite= editor.getSite(); diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/actions/MemberFilterActionGroup.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/actions/MemberFilterActionGroup.java index b652256bbf3..70abcba1f9a 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/actions/MemberFilterActionGroup.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/actions/MemberFilterActionGroup.java @@ -21,6 +21,11 @@ package org.eclipse.cdt.ui.actions; * to the actions installed in the view part's toolbar menu and is updated when the * state of the buttons changes. *

+ *

+ * This class may be instantiated; it is not intended to be subclassed. + *

+ * + * @noextend This class is not intended to be subclassed by clients. */ import java.util.ArrayList; diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/actions/OpenAction.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/actions/OpenAction.java index 5dcc6d20ad4..7421917fb9f 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/actions/OpenAction.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/actions/OpenAction.java @@ -76,6 +76,8 @@ public class OpenAction extends SelectionDispatchAction { /** * Note: This constructor is for internal use only. Clients should not call this constructor. + * + * @noreference This constructor is not intended to be referenced by clients. */ public OpenAction(CEditor editor) { this(editor.getEditorSite()); diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/actions/OpenViewActionGroup.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/actions/OpenViewActionGroup.java index 2233f84ea11..f54bd108e52 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/actions/OpenViewActionGroup.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/actions/OpenViewActionGroup.java @@ -84,6 +84,8 @@ public class OpenViewActionGroup extends ActionGroup { * org.eclipse.jface.viewers.IStructuredSelection. * * @param page the page that owns this action group + * + * @noreference This constructor is not intended to be referenced by clients. */ public OpenViewActionGroup(Page page, CEditor editor) { createSiteActions(page.getSite(), editor); diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/actions/SelectionDispatchAction.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/actions/SelectionDispatchAction.java index 8cc92e8ad86..8b3e33a619a 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/actions/SelectionDispatchAction.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/actions/SelectionDispatchAction.java @@ -41,9 +41,10 @@ import org.eclipse.ui.IWorkbenchSite; * * *

- * Note: This class is not intended to be subclassed outside the JDT UI plugin. + * Note: This class is not intended to be subclassed outside the CDT UI plugin. *

* + * @noextend This class is not intended to be subclassed by clients. * @since 2.0 */ public abstract class SelectionDispatchAction extends Action implements ISelectionChangedListener { diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/ICCompletionProposal.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/ICCompletionProposal.java index 500f8b5362a..ce4368d0abd 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/ICCompletionProposal.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/ICCompletionProposal.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2000, 2005 IBM Corporation and others. + * Copyright (c) 2000, 2008 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 @@ -16,6 +16,9 @@ import org.eclipse.jface.text.contentassist.ICompletionProposal; * CompletionProposal with a relevance value. * The relevance value is used to sort the completion proposals. Proposals with higher relevance * should be listed before proposals with lower relevance. + *

+ * This interface can be implemented by clients. + *

*/ public interface ICCompletionProposal extends ICompletionProposal { diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/ICHelpInvocationContext.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/ICHelpInvocationContext.java index 9154ee6c888..10029c1edc8 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/ICHelpInvocationContext.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/ICHelpInvocationContext.java @@ -1,5 +1,5 @@ /********************************************************************** - * Copyright (c) 2004, 2005 Intel Corporation and others. + * Copyright (c) 2004, 2008 Intel 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 @@ -15,7 +15,10 @@ import org.eclipse.cdt.core.model.ITranslationUnit; import org.eclipse.core.resources.IProject; /** - * Invocation context for the CHelpProviderManager + * Invocation context for the CHelpProviderManager. + * + * @noextend This interface is not intended to be extended by clients. + * @noimplement This interface is not intended to be implemented by clients. */ public interface ICHelpInvocationContext { diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/ICPartitions.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/ICPartitions.java index cec2ef253ef..d33898e88ed 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/ICPartitions.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/ICPartitions.java @@ -14,6 +14,8 @@ package org.eclipse.cdt.ui.text; /** * Definition of C partitioning and its partitions. * + * @noextend This interface is not intended to be extended by clients. + * @noimplement This interface is not intended to be implemented by clients. * @since 4.0 */ public interface ICPartitions { diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/ICTokenScanner.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/ICTokenScanner.java index f190b5e84c0..ca28dcb58cb 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/ICTokenScanner.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/ICTokenScanner.java @@ -16,6 +16,9 @@ import org.eclipse.cdt.ui.IPropertyChangeParticipant; /** * Interface for CDT Scanners. Scanners used in CDT must additionally be * IPropertyChangeParticipant's. + *

+ * Clients may implement this interface. + *

* * @since 5.0 */ diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/IInvocationContext.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/IInvocationContext.java index 23e4c713826..dfe008e3af7 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/IInvocationContext.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/IInvocationContext.java @@ -17,6 +17,8 @@ import org.eclipse.cdt.core.model.ITranslationUnit; *

* Note: this interface is not intended to be implemented. *

+ * @noimplement This interface is not intended to be implemented by clients. + * @noextend This interface is not intended to be extended by clients. */ public interface IInvocationContext { /** diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/IProblemLocation.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/IProblemLocation.java index fd05d178269..40b95549124 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/IProblemLocation.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/IProblemLocation.java @@ -12,6 +12,9 @@ package org.eclipse.cdt.ui.text; /** * Problem information for quick fix and quick assist processors. + * + * @noimplement This interface is not intended to be implemented by clients. + * @noextend This interface is not intended to be extended by clients. */ public interface IProblemLocation { /** diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/ITokenStore.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/ITokenStore.java index 4347a28dea0..63b9d34dd7a 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/ITokenStore.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/ITokenStore.java @@ -41,6 +41,9 @@ import org.eclipse.cdt.ui.PreferenceConstants; * Preference color key + {@link PreferenceConstants#EDITOR_UNDERLINE_SUFFIX} are used * to retrieve whether the token is rendered in underline. *

+ *

+ * Clients may implement this interface. + *

* * @see ITokenStoreFactory * @since 5.0 diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/ITokenStoreFactory.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/ITokenStoreFactory.java index 964d6a0ad17..edb1cb05e90 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/ITokenStoreFactory.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/ITokenStoreFactory.java @@ -12,6 +12,9 @@ package org.eclipse.cdt.ui.text; /** * A means of obtaining ITokenStore objects. + *

+ * Clients may implement this interface. + *

* @since 5.0 */ public interface ITokenStoreFactory { diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/TaskTagRule.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/TaskTagRule.java index 89979dc5879..5065cab1419 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/TaskTagRule.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/TaskTagRule.java @@ -28,6 +28,9 @@ import org.eclipse.cdt.ui.IPropertyChangeParticipant; * * Which words should be recognized as task tags is specified under {@link CCorePreferenceConstants#TODO_TASK_TAGS} as a * comma delimited list. + *

+ * Clients may instantiate and subclass. + *

* * @see CCorePreferenceConstants#TODO_TASK_TAGS * @since 5.0 diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/contentassist/ICEditorContentAssistInvocationContext.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/contentassist/ICEditorContentAssistInvocationContext.java index 1e874ef6adb..1b40daf827f 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/contentassist/ICEditorContentAssistInvocationContext.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/contentassist/ICEditorContentAssistInvocationContext.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2007 IBM Corporation and others. + * Copyright (c) 2007, 2008 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 @@ -21,6 +21,9 @@ import org.eclipse.cdt.core.model.ITranslationUnit; /** * Describes the context of a content assist invocation in a C/C++ editor. + * + * @noextend This interface is not intended to be extended by clients. + * @noimplement This interface is not intended to be implemented by clients. */ public interface ICEditorContentAssistInvocationContext { diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/contentassist/ICompletionProposalComputer.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/contentassist/ICompletionProposalComputer.java index 728884c7693..499afb69480 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/contentassist/ICompletionProposalComputer.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/contentassist/ICompletionProposalComputer.java @@ -19,8 +19,10 @@ import org.eclipse.jface.text.contentassist.IContextInformation; /** * Computes completions and context information displayed by the C/C++ editor content assistant. + *

* Contributions to the org.eclipse.cdt.ui.completionProposalComputer extension point * must implement this interface. + *

* * @since 4.0 */ diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/contentassist/IProposalFilter.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/contentassist/IProposalFilter.java index f3c91ce5170..461f6bc8614 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/contentassist/IProposalFilter.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/text/contentassist/IProposalFilter.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2006 Norbert Ploett and others. + * Copyright (c) 2006, 2008 Norbert Ploett 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 @@ -13,16 +13,23 @@ package org.eclipse.cdt.ui.text.contentassist; import org.eclipse.cdt.ui.text.ICCompletionProposal; +/** + * Filters completion proposals displayed by the C/C++ editor content assistant. + *

+ * Contributions to the org.eclipse.cdt.ui.ProposalFilter extension point + * must implement this interface. + *

+ */ public interface IProposalFilter { - - /** - * Filter a list of ICCompletionProposals
- * - Change the order of entries
- * - Remove undesired (duplicate) entries
- * - Supplement existing entries with additional information - * @param proposals The List of proposals - * @return The filtered list of proposals as array - */ - ICCompletionProposal[] filterProposals(ICCompletionProposal[] proposals) ; + + /** + * Filter a list of ICCompletionProposals
+ * - Change the order of entries
+ * - Remove undesired (duplicate) entries
+ * - Supplement existing entries with additional information + * @param proposals The List of proposals + * @return The filtered list of proposals as array + */ + ICCompletionProposal[] filterProposals(ICCompletionProposal[] proposals) ; } diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/wizards/NewFileCreationWizard.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/wizards/NewFileCreationWizard.java index 36ad1c8e490..754ec859952 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/wizards/NewFileCreationWizard.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/wizards/NewFileCreationWizard.java @@ -12,5 +12,9 @@ package org.eclipse.cdt.ui.wizards; import org.eclipse.ui.wizards.newresource.BasicNewFileResourceWizard; +/** + * @deprecated Use {@link BasicNewFileResourceWizard} instead. + */ +@Deprecated public class NewFileCreationWizard extends BasicNewFileResourceWizard { } diff --git a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/wizards/NewFolderCreationWizard.java b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/wizards/NewFolderCreationWizard.java index 6c0a3d0c6f2..442216a16af 100644 --- a/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/wizards/NewFolderCreationWizard.java +++ b/core/org.eclipse.cdt.ui/src/org/eclipse/cdt/ui/wizards/NewFolderCreationWizard.java @@ -12,5 +12,9 @@ package org.eclipse.cdt.ui.wizards; import org.eclipse.ui.wizards.newresource.BasicNewFolderResourceWizard; +/** + * @deprecated Use {@link BasicNewFolderResourceWizard} instead. + */ +@Deprecated public class NewFolderCreationWizard extends BasicNewFolderResourceWizard { }