1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-06-07 17:56:01 +02:00

API tags for org.eclipse.cdt.core, bug 260830.

This commit is contained in:
Markus Schorn 2009-02-04 08:51:22 +00:00
parent 5ee9cdd9d9
commit 1f0a621213
29 changed files with 104 additions and 65 deletions

View file

@ -17,9 +17,6 @@ import org.eclipse.cdt.core.settings.model.ICConfigurationDescription;
import org.eclipse.cdt.core.settings.model.ICLanguageSetting; import org.eclipse.cdt.core.settings.model.ICLanguageSetting;
import org.eclipse.cdt.core.settings.model.ICLanguageSettingEntry; import org.eclipse.cdt.core.settings.model.ICLanguageSettingEntry;
/**
* @noextend This class is not intended to be subclassed by clients.
*/
public class CDTListComparator implements Comparator<Object> { public class CDTListComparator implements Comparator<Object> {
private static Comparator<Object> comparator = null; private static Comparator<Object> comparator = null;

View file

@ -17,6 +17,8 @@ import org.eclipse.core.runtime.CoreException;
/** /**
* Interface for all nodes that can be visited by a {@link IPDOMVisitor}. * Interface for all nodes that can be visited by a {@link IPDOMVisitor}.
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
*/ */
public interface IPDOMNode { public interface IPDOMNode {
@ -28,6 +30,7 @@ public interface IPDOMNode {
/** /**
* Frees memory allocated by this node, the node may no longer be used. * Frees memory allocated by this node, the node may no longer be used.
* @param linkage the linkage the node belongs to. * @param linkage the linkage the node belongs to.
* @noreference This method is not intended to be referenced by clients.
*/ */
public void delete(PDOMLinkage linkage) throws CoreException; public void delete(PDOMLinkage linkage) throws CoreException;
} }

View file

@ -10,23 +10,39 @@
*******************************************************************************/ *******************************************************************************/
package org.eclipse.cdt.core; package org.eclipse.cdt.core;
import org.eclipse.cdt.internal.core.InternalCExtension;
import org.eclipse.core.resources.IProject; import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.PlatformObject;
public abstract class AbstractCExtension extends InternalCExtension implements ICExtension { public abstract class AbstractCExtension extends PlatformObject implements ICExtension {
private IProject fProject;
private ICExtensionReference extensionRef;
/** /**
* Returns the project for which this extrension is defined. * Returns the project for which this extrension is defined.
* *
* @return the project * @return the project
*/ */
@Override
public final IProject getProject() { public final IProject getProject() {
return super.getProject(); return fProject;
} }
@Override
public final ICExtensionReference getExtensionReference() { public final ICExtensionReference getExtensionReference() {
return super.getExtensionReference(); return extensionRef;
}
// internal stuff
/**
* @noreference This method is not intended to be referenced by clients.
*/
public void setProject(IProject project) {
fProject = project;
}
/**
* @noreference This method is not intended to be referenced by clients.
*/
public void setExtensionReference(ICExtensionReference extReference) {
extensionRef = extReference;
} }
} }

View file

@ -17,6 +17,10 @@ import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus; import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status; import org.eclipse.core.runtime.Status;
/**
* @noextend This class is not intended to be subclassed by clients.
* @noinstantiate This class is not intended to be instantiated by clients.
*/
public class CCProjectNature extends CProjectNature { public class CCProjectNature extends CProjectNature {
public static final String CC_NATURE_ID= CCorePlugin.PLUGIN_ID + ".ccnature"; //$NON-NLS-1$ public static final String CC_NATURE_ID= CCorePlugin.PLUGIN_ID + ".ccnature"; //$NON-NLS-1$

View file

@ -26,7 +26,8 @@ import org.eclipse.core.runtime.Status;
import org.eclipse.osgi.util.NLS; import org.eclipse.osgi.util.NLS;
/** /**
* @author hamer * @noextend This interface is not intended to be extended by clients.
* @noinstantiate This class is not intended to be instantiated by clients.
*/ */
public class CConventions { public class CConventions {
private final static String scopeResolutionOperator= "::"; //$NON-NLS-1$ private final static String scopeResolutionOperator= "::"; //$NON-NLS-1$

View file

@ -12,7 +12,10 @@
*******************************************************************************/ *******************************************************************************/
package org.eclipse.cdt.core; package org.eclipse.cdt.core;
/**
* @noextend This class is not intended to be subclassed by clients.
* @noinstantiate This class is not intended to be instantiated by clients.
*/
public class CCorePreferenceConstants { public class CCorePreferenceConstants {
/** /**

View file

@ -12,6 +12,10 @@ package org.eclipse.cdt.core;
import java.util.EventObject; import java.util.EventObject;
/**
* @noextend This class is not intended to be subclassed by clients.
* @noinstantiate This class is not intended to be instantiated by clients.
*/
public class CDescriptorEvent extends EventObject { public class CDescriptorEvent extends EventObject {
/** /**

View file

@ -22,6 +22,10 @@ import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor; import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.NullProgressMonitor; import org.eclipse.core.runtime.NullProgressMonitor;
/**
* @noextend This class is not intended to be subclassed by clients.
* @noinstantiate This class is not intended to be instantiated by clients.
*/
public class CProjectNature implements IProjectNature { public class CProjectNature implements IProjectNature {
public static final String C_NATURE_ID = CCorePlugin.PLUGIN_ID + ".cnature"; //$NON-NLS-1$ public static final String C_NATURE_ID = CCorePlugin.PLUGIN_ID + ".cnature"; //$NON-NLS-1$

View file

@ -10,10 +10,6 @@
*******************************************************************************/ *******************************************************************************/
package org.eclipse.cdt.core; package org.eclipse.cdt.core;
/*
* (c) Copyright IBM Corp. 2000, 2001. All Rights Reserved.
*/
import java.io.File; import java.io.File;
import java.io.IOException; import java.io.IOException;
import java.io.OutputStream; import java.io.OutputStream;
@ -25,6 +21,9 @@ import org.eclipse.cdt.utils.spawner.ProcessFactory;
import org.eclipse.core.runtime.IPath; import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IProgressMonitor; import org.eclipse.core.runtime.IProgressMonitor;
/**
* @noextend This class is not intended to be subclassed by clients.
*/
public class CommandLauncher { public class CommandLauncher {
public final static int COMMAND_CANCELED = 1; public final static int COMMAND_CANCELED = 1;

View file

@ -17,6 +17,8 @@ import java.io.OutputStream;
/** /**
* Output stream which storing the console output * Output stream which storing the console output
*
* @noinstantiate This class is not intended to be instantiated by clients.
*/ */
public class ConsoleOutputStream extends OutputStream { public class ConsoleOutputStream extends OutputStream {

View file

@ -37,6 +37,9 @@ import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath; import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.Path; import org.eclipse.core.runtime.Path;
/**
* @noextend This class is not intended to be subclassed by clients.
*/
public class ErrorParserManager extends OutputStream { public class ErrorParserManager extends OutputStream {
private int nOpens; private int nOpens;

View file

@ -16,6 +16,10 @@ import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.CoreException; import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor; import org.eclipse.core.runtime.IProgressMonitor;
/**
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
*/
public interface ICDescriptorManager { public interface ICDescriptorManager {
public void configure(IProject project, String id) throws CoreException; public void configure(IProject project, String id) throws CoreException;

View file

@ -15,6 +15,10 @@ import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.CoreException; import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor; import org.eclipse.core.runtime.IProgressMonitor;
/**
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
*/
public interface ICDescriptorOperation { public interface ICDescriptorOperation {
/** /**

View file

@ -14,6 +14,8 @@ import org.eclipse.core.resources.IProject;
/** /**
* This represents an executable extension in the cmodel hierarchy * This represents an executable extension in the cmodel hierarchy
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
*/ */
public interface ICExtension { public interface ICExtension {
public IProject getProject(); public IProject getProject();

View file

@ -10,6 +10,10 @@
*******************************************************************************/ *******************************************************************************/
package org.eclipse.cdt.core; package org.eclipse.cdt.core;
/**
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
*/
public interface ICExtensionDescriptor { public interface ICExtensionDescriptor {
String getName(); String getName();

View file

@ -24,6 +24,9 @@ import org.eclipse.core.runtime.IConfigurationElement;
* @see ICConfigExtensionReference * @see ICConfigExtensionReference
* @see ICExtension * @see ICExtension
* @see ICDescriptor * @see ICDescriptor
*
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
*/ */
public interface ICExtensionReference { public interface ICExtensionReference {

View file

@ -14,6 +14,8 @@ package org.eclipse.cdt.core;
/** /**
* @author bgheorgh * @author bgheorgh
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
*/ */
public interface ICLogConstants { public interface ICLogConstants {
public class LogConst { public class LogConst {

View file

@ -12,6 +12,10 @@ package org.eclipse.cdt.core;
import org.eclipse.core.runtime.CoreException; import org.eclipse.core.runtime.CoreException;
/**
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
*/
public interface ICOwner { public interface ICOwner {
public void configure(ICDescriptor cproject) throws CoreException; public void configure(ICDescriptor cproject) throws CoreException;
public void update(ICDescriptor cproject, String extensionID) throws CoreException; public void update(ICDescriptor cproject, String extensionID) throws CoreException;

View file

@ -10,6 +10,10 @@
*******************************************************************************/ *******************************************************************************/
package org.eclipse.cdt.core; package org.eclipse.cdt.core;
/**
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
*/
public interface ICOwnerInfo { public interface ICOwnerInfo {
public String getID(); public String getID();
public String getName(); public String getName();

View file

@ -14,6 +14,8 @@ package org.eclipse.cdt.core;
* A basic interface for console parsers * A basic interface for console parsers
* *
* @author vhirsl * @author vhirsl
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
*/ */
public interface IConsoleParser { public interface IConsoleParser {
/** /**

View file

@ -14,6 +14,7 @@ import org.eclipse.core.resources.IResource;
/** /**
* @author sam.robb * @author sam.robb
* @noextend This interface is not intended to be extended by clients.
*/ */
public interface IMarkerGenerator { public interface IMarkerGenerator {
int SEVERITY_INFO = 0; int SEVERITY_INFO = 0;

View file

@ -30,16 +30,10 @@ import org.eclipse.jface.text.IRegion;
* An deletion followed by an insertion without saving the file inbetween, will cancel * An deletion followed by an insertion without saving the file inbetween, will cancel
* the deletion as far as possible. * the deletion as far as possible.
* *
* <p> This interface is not intended to be implemented by clients. </p>
*
* <p>
* <strong>EXPERIMENTAL</strong>. This interface has been added as
* part of a work in progress. There is no guarantee that this API will
* work or that it will remain the same. Please do not use this API without
* consulting with the CDT team.
* </p>
*
* @since 4.0 * @since 4.0
*
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
*/ */
public interface IPositionConverter { public interface IPositionConverter {

View file

@ -10,6 +10,10 @@
*******************************************************************************/ *******************************************************************************/
package org.eclipse.cdt.core; package org.eclipse.cdt.core;
/**
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
*/
public interface IProcessInfo { public interface IProcessInfo {
public int getPid(); public int getPid();
public String getName(); public String getName();

View file

@ -10,6 +10,10 @@
*******************************************************************************/ *******************************************************************************/
package org.eclipse.cdt.core; package org.eclipse.cdt.core;
/**
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
*/
public interface IProcessList { public interface IProcessList {
public IProcessInfo[] getProcessList(); public IProcessInfo[] getProcessList();
} }

View file

@ -15,6 +15,8 @@ package org.eclipse.cdt.core;
* *
* This initial version only returns a list of source files. * This initial version only returns a list of source files.
* *
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
*/ */
public interface ISymbolReader { public interface ISymbolReader {

View file

@ -14,6 +14,9 @@ package org.eclipse.cdt.core;
import org.eclipse.core.resources.IResource; import org.eclipse.core.resources.IResource;
import org.eclipse.core.runtime.IPath; import org.eclipse.core.runtime.IPath;
/**
* @noextend This class is not intended to be subclassed by clients.
*/
public class ProblemMarkerInfo { public class ProblemMarkerInfo {
public IResource file; public IResource file;

View file

@ -24,6 +24,8 @@ import org.eclipse.core.runtime.IExtensionPoint;
import org.eclipse.core.runtime.Platform; import org.eclipse.core.runtime.Platform;
/** /**
* @noextend This class is not intended to be subclassed by clients.
* @noinstantiate This class is not intended to be instantiated by clients.
*/ */
public class ToolFactory { public class ToolFactory {

View file

@ -20,6 +20,7 @@ import java.util.HashMap;
import java.util.LinkedHashSet; import java.util.LinkedHashSet;
import java.util.Map; import java.util.Map;
import org.eclipse.cdt.core.AbstractCExtension;
import org.eclipse.cdt.core.CCorePlugin; import org.eclipse.cdt.core.CCorePlugin;
import org.eclipse.cdt.core.CDescriptorEvent; import org.eclipse.cdt.core.CDescriptorEvent;
import org.eclipse.cdt.core.ICDescriptor; import org.eclipse.cdt.core.ICDescriptor;
@ -155,12 +156,12 @@ final public class CConfigBasedDescriptor implements ICDescriptor {
} }
public ICExtension createExtension() throws CoreException { public ICExtension createExtension() throws CoreException {
InternalCExtension cExtension = null; AbstractCExtension cExtension = null;
IConfigurationElement el = CExtensionUtil.getFirstConfigurationElement(fCfgExtRef, CEXTENSION_NAME, false); IConfigurationElement el = CExtensionUtil.getFirstConfigurationElement(fCfgExtRef, CEXTENSION_NAME, false);
cExtension = (InternalCExtension)el.createExecutableExtension("run"); //$NON-NLS-1$ cExtension = (AbstractCExtension)el.createExecutableExtension("run"); //$NON-NLS-1$
cExtension.setExtensionReference(this); cExtension.setExtensionReference(this);
cExtension.setProject(getProject()); cExtension.setProject(getProject());
return (ICExtension)cExtension; return cExtension;
} }
public ICDescriptor getCDescriptor() { public ICDescriptor getCDescriptor() {

View file

@ -1,37 +0,0 @@
/*******************************************************************************
* Copyright (c) 2000, 2005 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
*******************************************************************************/
package org.eclipse.cdt.internal.core;
import org.eclipse.cdt.core.ICExtensionReference;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.PlatformObject;
public abstract class InternalCExtension extends PlatformObject {
private IProject fProject;
private ICExtensionReference extensionRef;
protected void setProject(IProject project) {
fProject = project;
}
void setExtensionReference(ICExtensionReference extReference) {
extensionRef = extReference;
}
protected IProject getProject() {
return fProject;
}
protected ICExtensionReference getExtensionReference() {
return extensionRef;
}
}