1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-06-09 10:46:02 +02:00

API Cleanup

This commit is contained in:
Anton Leherbauer 2008-12-18 10:49:32 +00:00
parent 2adb6f5d2b
commit 14790ea880
39 changed files with 186 additions and 37 deletions

View file

@ -352,7 +352,7 @@
category="org.eclipse.cdt.ui.newCWizards" category="org.eclipse.cdt.ui.newCWizards"
finalPerspective="org.eclipse.cdt.ui.CPerspective" finalPerspective="org.eclipse.cdt.ui.CPerspective"
id="org.eclipse.cdt.ui.wizards.NewFolderCreationWizard"> id="org.eclipse.cdt.ui.wizards.NewFolderCreationWizard">
<class class="org.eclipse.cdt.ui.wizards.NewFolderCreationWizard"> <class class="org.eclipse.ui.wizards.newresource.BasicNewFolderResourceWizard">
<parameter name="cfolder" value="true"/> <parameter name="cfolder" value="true"/>
</class> </class>
<description> <description>
@ -436,7 +436,7 @@
category="org.eclipse.cdt.ui.newCCWizards" category="org.eclipse.cdt.ui.newCCWizards"
finalPerspective="org.eclipse.cdt.ui.CPerspective" finalPerspective="org.eclipse.cdt.ui.CPerspective"
id="org.eclipse.cdt.ui.wizards.NewFolderCreationWizard"> id="org.eclipse.cdt.ui.wizards.NewFolderCreationWizard">
<class class="org.eclipse.cdt.ui.wizards.NewFolderCreationWizard"> <class class="org.eclipse.ui.wizards.newresource.BasicNewFolderResourceWizard">
<parameter name="cfolder" value="true"/> <parameter name="cfolder" value="true"/>
</class> </class>
<description> <description>

View file

@ -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 * All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0 * are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at * 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. * 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 { public class CDTUIImages {

View file

@ -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.util.Util;
import org.eclipse.cdt.internal.ui.viewsupport.CDTContextActivator; 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 class CUIPlugin extends AbstractUIPlugin {
public static final String PLUGIN_ID = "org.eclipse.cdt.ui"; //$NON-NLS-1$ 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 * The id of the C hierarchy perspective
* (value <code>"org.eclipse.cdt.ui.CHierarchyPerspective"</code>). * (value <code>"org.eclipse.cdt.ui.CHierarchyPerspective"</code>).
*
* @deprecated This perspective no longer exists.
*/ */
@Deprecated
public static final String ID_CHIERARCHY_PERSPECTIVE = PLUGIN_ID + ".CHierarchyPerspective"; //$NON-NLS-1$ public static final String ID_CHIERARCHY_PERSPECTIVE = PLUGIN_ID + ".CHierarchyPerspective"; //$NON-NLS-1$
/** /**
@ -143,7 +150,9 @@ public class CUIPlugin extends AbstractUIPlugin {
* (value <code>"org.eclipse.cdt.ui.CBrowsingPerspective"</code>). * (value <code>"org.eclipse.cdt.ui.CBrowsingPerspective"</code>).
* *
* @since 2.0 * @since 2.0
* @deprecated This perspective no longer exists.
*/ */
@Deprecated
public static final String ID_CBROWSING_PERSPECTIVE = PLUGIN_ID + ".CBrowsingPerspective"; //$NON-NLS-1$ public static final String ID_CBROWSING_PERSPECTIVE = PLUGIN_ID + ".CBrowsingPerspective"; //$NON-NLS-1$
/** /**
@ -151,7 +160,9 @@ public class CUIPlugin extends AbstractUIPlugin {
* (value <code>"org.eclipse.cdt.ui.ProjectsView"</code>). * (value <code>"org.eclipse.cdt.ui.ProjectsView"</code>).
* *
* @since 2.0 * @since 2.0
* @deprecated This view no longer exists.
*/ */
@Deprecated
public static String ID_PROJECTS_VIEW = PLUGIN_ID + ".ProjectsView"; //$NON-NLS-1$ public static String ID_PROJECTS_VIEW = PLUGIN_ID + ".ProjectsView"; //$NON-NLS-1$
/** /**
@ -159,7 +170,9 @@ public class CUIPlugin extends AbstractUIPlugin {
* (value <code>"org.eclipse.cdt.ui.NamespacesView"</code>). * (value <code>"org.eclipse.cdt.ui.NamespacesView"</code>).
* *
* @since 2.0 * @since 2.0
* @deprecated This view no longer exists.
*/ */
@Deprecated
public static String ID_NAMESPACES_VIEW = PLUGIN_ID + ".NamespacesView"; //$NON-NLS-1$ public static String ID_NAMESPACES_VIEW = PLUGIN_ID + ".NamespacesView"; //$NON-NLS-1$
/** /**
@ -167,7 +180,9 @@ public class CUIPlugin extends AbstractUIPlugin {
* (value <code>"org.eclipse.cdt.ui.TypesView"</code>). * (value <code>"org.eclipse.cdt.ui.TypesView"</code>).
* *
* @since 2.0 * @since 2.0
* @deprecated This view no longer exists.
*/ */
@Deprecated
public static String ID_TYPES_VIEW = PLUGIN_ID + ".TypesView"; //$NON-NLS-1$ public static String ID_TYPES_VIEW = PLUGIN_ID + ".TypesView"; //$NON-NLS-1$
/** /**
@ -175,7 +190,9 @@ public class CUIPlugin extends AbstractUIPlugin {
* (value <code>"org.eclipse.cdt.ui.MembersView"</code>). * (value <code>"org.eclipse.cdt.ui.MembersView"</code>).
* *
* @since 2.0 * @since 2.0
* @deprecated This view no longer exists.
*/ */
@Deprecated
public static String ID_MEMBERS_VIEW = PLUGIN_ID + ".MembersView"; //$NON-NLS-1$ 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() { public synchronized IBufferFactory getBufferFactory() {
if (fBufferFactory == null) if (fBufferFactory == null)
fBufferFactory= new CustomBufferFactory(); 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() { public synchronized CDocumentProvider getDocumentProvider() {
if (fDocumentProvider == null) { if (fDocumentProvider == null) {
@ -563,6 +585,9 @@ public class CUIPlugin extends AbstractUIPlugin {
return PLUGIN_ID; return PLUGIN_ID;
} }
/**
* @noreference This method is not intended to be referenced by clients.
*/
public static ImageDescriptorRegistry getImageDescriptorRegistry() { public static ImageDescriptorRegistry getImageDescriptorRegistry() {
return getDefault().internalGetImageDescriptorRegistry(); 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() { public ProblemMarkerManager getProblemMarkerManager() {
if (fProblemMarkerManager == null) if (fProblemMarkerManager == null)
@ -710,6 +737,8 @@ public class CUIPlugin extends AbstractUIPlugin {
* Returns all C editor text hovers contributed to the workbench. * Returns all C editor text hovers contributed to the workbench.
* *
* @return an array of CEditorTextHoverDescriptor * @return an array of CEditorTextHoverDescriptor
*
* @noreference This method is not intended to be referenced by clients.
*/ */
public CEditorTextHoverDescriptor[] getCEditorTextHoverDescriptors() { public CEditorTextHoverDescriptor[] getCEditorTextHoverDescriptors() {
if (fCEditorTextHoverDescriptors == null) { if (fCEditorTextHoverDescriptors == null) {
@ -806,6 +835,8 @@ public class CUIPlugin extends AbstractUIPlugin {
* extension point. * extension point.
* *
* @return the registry of contributed <code>ICFoldingStructureProvider</code> * @return the registry of contributed <code>ICFoldingStructureProvider</code>
*
* @noreference This method is not intended to be referenced by clients.
* @since 3.0 * @since 3.0
*/ */
public synchronized CFoldingStructureProviderRegistry getFoldingStructureProviderRegistry() { public synchronized CFoldingStructureProviderRegistry getFoldingStructureProviderRegistry() {
@ -893,6 +924,8 @@ public class CUIPlugin extends AbstractUIPlugin {
* Returns the AST provider. * Returns the AST provider.
* *
* @return the AST provider * @return the AST provider
*
* @noreference This method is not intended to be referenced by clients.
* @since 4.0 * @since 4.0
*/ */
public synchronized ASTProvider getASTProvider() { public synchronized ASTProvider getASTProvider() {

View file

@ -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. * 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 * @since 2.1
*/ */
public class CodeGeneration { public class CodeGeneration {

View file

@ -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 * All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0 * are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at * which accompanies this distribution, and is available at
@ -12,6 +12,13 @@ package org.eclipse.cdt.ui;
import org.eclipse.core.resources.IProject; 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 { public interface IBuildConsoleEvent {
final static int CONSOLE_START = 1; final static int CONSOLE_START = 1;
final static int CONSOLE_CLOSE = 2; final static int CONSOLE_CLOSE = 2;

View file

@ -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 * All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0 * are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at * which accompanies this distribution, and is available at
@ -10,6 +10,14 @@
*******************************************************************************/ *******************************************************************************/
package org.eclipse.cdt.ui; package org.eclipse.cdt.ui;
/**
* A listener to build console events.
* <p>
* Clients may implement this interface.
* </p>
*
* @see IBuildConsoleEvent
*/
public interface IBuildConsoleListener { public interface IBuildConsoleListener {
void consoleChange(IBuildConsoleEvent event); void consoleChange(IBuildConsoleEvent event);
} }

View file

@ -14,6 +14,9 @@ import org.eclipse.cdt.core.resources.IConsole;
import org.eclipse.core.resources.IProject; import org.eclipse.core.resources.IProject;
import org.eclipse.jface.text.IDocument; import org.eclipse.jface.text.IDocument;
/**
* @noimplement This interface is not intended to be implemented by clients.
*/
public interface IBuildConsoleManager { public interface IBuildConsoleManager {
IConsole getConsole(IProject project); IConsole getConsole(IProject project);
IDocument getConsoleDocument(IProject project); IDocument getConsoleDocument(IProject project);

View file

@ -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 * All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0 * are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at * which accompanies this distribution, and is available at
@ -11,6 +11,9 @@
package org.eclipse.cdt.ui; package org.eclipse.cdt.ui;
/**
* @noimplement This interface is not intended to be implemented by clients.
*/
public interface ICDTConstants public interface ICDTConstants
{ {
// CDT Extension Points // 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_NAME = "name"; //$NON-NLS-1$
public static final String ATT_PERSPECTIVE = "perspective"; //$NON-NLS-1$ public static final String ATT_PERSPECTIVE = "perspective"; //$NON-NLS-1$
} }

View file

@ -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 * All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0 * are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at * 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. * Represents the help book, that is a set of articles on some topic.
* Such as "C functions", "Qt library", etc., provided by help provider. * Such as "C functions", "Qt library", etc., provided by help provider.
* <p>
* Clients may implement this interface.
* </p>
* @see ICHelpProvider * @see ICHelpProvider
* @since 2.1 * @since 2.1
*/ */

View file

@ -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 * All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0 * are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at * 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 * Represents the C/C++ help provider
* <p>
* Clients may implement this interface.
* </p>
* *
* @since 2.1 * @since 2.1
*/ */

View file

@ -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 * All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0 * are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at * 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 * This interface represents Help Resources found in the certain Help Book
* provided by certain CHelpProvider * provided by certain CHelpProvider
* <p>
* Clients may implement this interface.
* </p>
* @see ICHelpProvider * @see ICHelpProvider
* @since 2.1 * @since 2.1
*/ */

View file

@ -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 * All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0 * are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at * 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. * This interface allows to create flexible editor inputs.
* *
* @since May 21, 2003 * @since May 21, 2003
* @deprecated Not supported anymore.
*/ */
@Deprecated
public interface IEditorInputDelegate extends IEditorInput { public interface IEditorInputDelegate extends IEditorInput {
/** /**
* Returns the editor input delegate for this editor input. * Returns the editor input delegate for this editor input.

View file

@ -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 * All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0 * are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at * which accompanies this distribution, and is available at
@ -11,8 +11,18 @@
package org.eclipse.cdt.ui; package org.eclipse.cdt.ui;
/**
* <p>
* Clients may implement this interface.
* </p>
*/
public interface IFunctionSummary { public interface IFunctionSummary {
/**
* <p>
* Clients may implement this interface.
* </p>
*/
public interface IFunctionPrototypeSummary { public interface IFunctionPrototypeSummary {
/** /**
* Get the name of the function. This should be the * Get the name of the function. This should be the

View file

@ -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 * All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0 * are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at * which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html * http://www.eclipse.org/legal/epl-v10.html
* *
* Contributors: * Contributors:
* QNX Software Systems - Initial API and implementation * Doug Schaefer (QNX Software Systems) - Initial API and implementation
**********************************************************************/ **********************************************************************/
package org.eclipse.cdt.ui; package org.eclipse.cdt.ui;
@ -15,8 +15,11 @@ import org.eclipse.core.runtime.IAdaptable;
import org.eclipse.jface.text.rules.RuleBasedScanner; 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.
* <p>
* Clients may implement this interface.
* </p>
*/ */
public interface ILanguageUI extends IAdaptable { public interface ILanguageUI extends IAdaptable {

View file

@ -16,6 +16,9 @@ import org.eclipse.jface.util.PropertyChangeEvent;
* Implemented by classes which can optionally participate in property * Implemented by classes which can optionally participate in property
* change events, and report whether an event would affect them without * change events, and report whether an event would affect them without
* adapting to it. * adapting to it.
* <p>
* Clients may implement this interface.
* </p>
* *
* @since 5.0 * @since 5.0
*/ */

View file

@ -29,7 +29,8 @@ import org.eclipse.ui.IEditorInput;
* <p> * <p>
* This interface is not intended to be implemented by clients. * This interface is not intended to be implemented by clients.
* </p> * </p>
* * @noimplement This interface is not intended to be implemented by clients.
*
* @see CUIPlugin#getWorkingCopyManager * @see CUIPlugin#getWorkingCopyManager
*/ */
public interface IWorkingCopyManager { public interface IWorkingCopyManager {

View file

@ -16,6 +16,7 @@ import org.eclipse.ui.IEditorInput;
/** /**
* Extension interface for <code>IWorkingCopyManager</code>. * Extension interface for <code>IWorkingCopyManager</code>.
* @noimplement This interface is not intended to be implemented by clients.
* @since 2.1 * @since 2.1
*/ */
public interface IWorkingCopyManagerExtension { public interface IWorkingCopyManagerExtension {

View file

@ -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 * 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 * CDT-UI preference store using these values. Clients are not allowed to modify the
* preference store programmatically. * 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 * @since 2.0
*/ */
public class PreferenceConstants { public class PreferenceConstants {
private PreferenceConstants() { private PreferenceConstants() {

View file

@ -18,6 +18,7 @@ package org.eclipse.cdt.ui.actions;
* This class may be instantiated; it is not intended to be subclassed. * This class may be instantiated; it is not intended to be subclassed.
* </p> * </p>
* *
* @noextend This class is not intended to be subclassed by clients.
* @since 2.0 * @since 2.0
*/ */
public class CdtActionConstants { public class CdtActionConstants {

View file

@ -65,6 +65,7 @@ import org.eclipse.cdt.internal.ui.filters.NamePatternFilter;
* This class may be instantiated; it is not intended to be subclassed. * This class may be instantiated; it is not intended to be subclassed.
* </p> * </p>
* *
* @noextend This class is not intended to be subclassed by clients.
* @since 2.0 * @since 2.0
*/ */
public class CustomFiltersActionGroup extends ActionGroup { public class CustomFiltersActionGroup extends ActionGroup {

View file

@ -51,6 +51,7 @@ import org.eclipse.cdt.internal.ui.editor.ICEditorActionDefinitionIds;
* This class may be instantiated; it is not intended to be subclassed. * This class may be instantiated; it is not intended to be subclassed.
* </p> * </p>
* *
* @noextend This class is not intended to be subclassed by clients.
* @since 4.0 * @since 4.0
*/ */
public class GenerateActionGroup extends ActionGroup { 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. * Note: This constructor is for internal use only. Clients should not call this constructor.
* @param editor the C editor * @param editor the C editor
* @param groupName the group name to add the action to * @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) { public GenerateActionGroup(CEditor editor, String groupName) {
fSite= editor.getSite(); fSite= editor.getSite();

View file

@ -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 * to the actions installed in the view part's toolbar menu and is updated when the
* state of the buttons changes. * state of the buttons changes.
* <p> * <p>
* <p>
* This class may be instantiated; it is not intended to be subclassed.
* </p>
*
* @noextend This class is not intended to be subclassed by clients.
*/ */
import java.util.ArrayList; import java.util.ArrayList;

View file

@ -76,6 +76,8 @@ public class OpenAction extends SelectionDispatchAction {
/** /**
* Note: This constructor is for internal use only. Clients should not call this constructor. * 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) { public OpenAction(CEditor editor) {
this(editor.getEditorSite()); this(editor.getEditorSite());

View file

@ -84,6 +84,8 @@ public class OpenViewActionGroup extends ActionGroup {
* org.eclipse.jface.viewers.IStructuredSelection</code>. * org.eclipse.jface.viewers.IStructuredSelection</code>.
* *
* @param page the page that owns this action group * @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) { public OpenViewActionGroup(Page page, CEditor editor) {
createSiteActions(page.getSite(), editor); createSiteActions(page.getSite(), editor);

View file

@ -41,9 +41,10 @@ import org.eclipse.ui.IWorkbenchSite;
* </ul> * </ul>
* *
* <p> * <p>
* 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.
* </p> * </p>
* *
* @noextend This class is not intended to be subclassed by clients.
* @since 2.0 * @since 2.0
*/ */
public abstract class SelectionDispatchAction extends Action implements ISelectionChangedListener { public abstract class SelectionDispatchAction extends Action implements ISelectionChangedListener {

View file

@ -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 * All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0 * are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at * which accompanies this distribution, and is available at
@ -16,6 +16,9 @@ import org.eclipse.jface.text.contentassist.ICompletionProposal;
* CompletionProposal with a relevance value. * CompletionProposal with a relevance value.
* The relevance value is used to sort the completion proposals. Proposals with higher relevance * The relevance value is used to sort the completion proposals. Proposals with higher relevance
* should be listed before proposals with lower relevance. * should be listed before proposals with lower relevance.
* <p>
* This interface can be implemented by clients.
* </p>
*/ */
public interface ICCompletionProposal extends ICompletionProposal { public interface ICCompletionProposal extends ICompletionProposal {

View file

@ -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 * All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0 * are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at * 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; 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 { public interface ICHelpInvocationContext {

View file

@ -14,6 +14,8 @@ package org.eclipse.cdt.ui.text;
/** /**
* Definition of C partitioning and its partitions. * 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 * @since 4.0
*/ */
public interface ICPartitions { public interface ICPartitions {

View file

@ -16,6 +16,9 @@ import org.eclipse.cdt.ui.IPropertyChangeParticipant;
/** /**
* Interface for CDT Scanners. Scanners used in CDT must additionally be * Interface for CDT Scanners. Scanners used in CDT must additionally be
* IPropertyChangeParticipant's. * IPropertyChangeParticipant's.
* <p>
* Clients may implement this interface.
* </p>
* *
* @since 5.0 * @since 5.0
*/ */

View file

@ -17,6 +17,8 @@ import org.eclipse.cdt.core.model.ITranslationUnit;
* <p> * <p>
* Note: this interface is not intended to be implemented. * Note: this interface is not intended to be implemented.
* </p> * </p>
* @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 { public interface IInvocationContext {
/** /**

View file

@ -12,6 +12,9 @@ package org.eclipse.cdt.ui.text;
/** /**
* Problem information for quick fix and quick assist processors. * 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 { public interface IProblemLocation {
/** /**

View file

@ -41,6 +41,9 @@ import org.eclipse.cdt.ui.PreferenceConstants;
* Preference color key + {@link PreferenceConstants#EDITOR_UNDERLINE_SUFFIX} are used * Preference color key + {@link PreferenceConstants#EDITOR_UNDERLINE_SUFFIX} are used
* to retrieve whether the token is rendered in underline. * to retrieve whether the token is rendered in underline.
* </p> * </p>
* <p>
* Clients may implement this interface.
* </p>
* *
* @see ITokenStoreFactory * @see ITokenStoreFactory
* @since 5.0 * @since 5.0

View file

@ -12,6 +12,9 @@ package org.eclipse.cdt.ui.text;
/** /**
* A means of obtaining ITokenStore objects. * A means of obtaining ITokenStore objects.
* <p>
* Clients may implement this interface.
* </p>
* @since 5.0 * @since 5.0
*/ */
public interface ITokenStoreFactory { public interface ITokenStoreFactory {

View file

@ -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 * Which words should be recognized as task tags is specified under {@link CCorePreferenceConstants#TODO_TASK_TAGS} as a
* comma delimited list. * comma delimited list.
* <p>
* Clients may instantiate and subclass.
* </p>
* *
* @see CCorePreferenceConstants#TODO_TASK_TAGS * @see CCorePreferenceConstants#TODO_TASK_TAGS
* @since 5.0 * @since 5.0

View file

@ -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 * All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0 * are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at * 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. * 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 { public interface ICEditorContentAssistInvocationContext {

View file

@ -19,8 +19,10 @@ import org.eclipse.jface.text.contentassist.IContextInformation;
/** /**
* Computes completions and context information displayed by the C/C++ editor content assistant. * Computes completions and context information displayed by the C/C++ editor content assistant.
* <p>
* Contributions to the <tt>org.eclipse.cdt.ui.completionProposalComputer</tt> extension point * Contributions to the <tt>org.eclipse.cdt.ui.completionProposalComputer</tt> extension point
* must implement this interface. * must implement this interface.
* </p>
* *
* @since 4.0 * @since 4.0
*/ */

View file

@ -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 * All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0 * are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at * 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; import org.eclipse.cdt.ui.text.ICCompletionProposal;
/**
* Filters completion proposals displayed by the C/C++ editor content assistant.
* <p>
* Contributions to the <tt>org.eclipse.cdt.ui.ProposalFilter</tt> extension point
* must implement this interface.
* </p>
*/
public interface IProposalFilter { public interface IProposalFilter {
/** /**
* Filter a list of ICCompletionProposals <br> * Filter a list of ICCompletionProposals <br>
* - Change the order of entries <br> * - Change the order of entries <br>
* - Remove undesired (duplicate) entries <br> * - Remove undesired (duplicate) entries <br>
* - Supplement existing entries with additional information * - Supplement existing entries with additional information
* @param proposals The List of proposals * @param proposals The List of proposals
* @return The filtered list of proposals as array * @return The filtered list of proposals as array
*/ */
ICCompletionProposal[] filterProposals(ICCompletionProposal[] proposals) ; ICCompletionProposal[] filterProposals(ICCompletionProposal[] proposals) ;
} }

View file

@ -12,5 +12,9 @@ package org.eclipse.cdt.ui.wizards;
import org.eclipse.ui.wizards.newresource.BasicNewFileResourceWizard; import org.eclipse.ui.wizards.newresource.BasicNewFileResourceWizard;
/**
* @deprecated Use {@link BasicNewFileResourceWizard} instead.
*/
@Deprecated
public class NewFileCreationWizard extends BasicNewFileResourceWizard { public class NewFileCreationWizard extends BasicNewFileResourceWizard {
} }

View file

@ -12,5 +12,9 @@ package org.eclipse.cdt.ui.wizards;
import org.eclipse.ui.wizards.newresource.BasicNewFolderResourceWizard; import org.eclipse.ui.wizards.newresource.BasicNewFolderResourceWizard;
/**
* @deprecated Use {@link BasicNewFolderResourceWizard} instead.
*/
@Deprecated
public class NewFolderCreationWizard extends BasicNewFolderResourceWizard { public class NewFolderCreationWizard extends BasicNewFolderResourceWizard {
} }