1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-08-05 07:15:39 +02:00

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

This commit is contained in:
Markus Schorn 2009-02-04 11:03:38 +00:00
parent fb24d5064c
commit 0853d042fb
19 changed files with 65 additions and 99 deletions

View file

@ -1,5 +1,5 @@
/******************************************************************************* /*******************************************************************************
* Copyright (c) 2006, 2008 Wind River Systems, Inc. and others. * Copyright (c) 2006, 2009 Wind River Systems, Inc. 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,15 +22,8 @@ import org.eclipse.core.runtime.IProgressMonitor;
/** /**
* Interface for accessing the index for one or more projects. * Interface for accessing the index for one or more projects.
* *
* <p> * @noextend This interface is not intended to be extended by clients.
* This interface is not intended to be implemented by clients. * @noimplement This interface is not intended to be implemented by clients.
* </p>
* <p>
* <strong>EXPERIMENTAL</strong>. This class or 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
*/ */

View file

@ -1,5 +1,5 @@
/******************************************************************************* /*******************************************************************************
* Copyright (c) 2006, 2008 Wind River Systems, Inc. and others. * Copyright (c) 2006, 2009 Wind River Systems, Inc. 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
@ -18,6 +18,7 @@ import org.eclipse.core.runtime.CoreException;
* Represents the semantics of a name in the index. * Represents the semantics of a name in the index.
* @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. * @noimplement This interface is not intended to be implemented by clients.
*/ */
public interface IIndexBinding extends IBinding { public interface IIndexBinding extends IBinding {

View file

@ -16,12 +16,9 @@ import org.eclipse.cdt.core.model.ICProject;
/** /**
* IndexChangeEvents describe changes to the index. * IndexChangeEvents describe changes to the index.
* <p> *
* <strong>EXPERIMENTAL</strong>. This class or interface has been added as * @noextend This interface is not intended to be extended by clients.
* part of a work in progress. There is no guarantee that this API will work or * @noimplement This interface is not intended to be implemented by clients.
* 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
*/ */

View file

@ -1,5 +1,5 @@
/******************************************************************************* /*******************************************************************************
* Copyright (c) 2006, 2008 Wind River Systems, Inc. and others. * Copyright (c) 2006, 2009 Wind River Systems, Inc. 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
@ -17,15 +17,8 @@ import org.eclipse.core.runtime.CoreException;
/** /**
* Represents a file that has been indexed. * Represents a file that has been indexed.
* *
* <p> * @noextend This interface is not intended to be extended by clients.
* This interface is not intended to be implemented by clients. * @noimplement This interface is not intended to be implemented by clients.
* </p>
* <p>
* <strong>EXPERIMENTAL</strong>. This class or 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
*/ */

View file

@ -15,16 +15,9 @@ import java.net.URI;
/** /**
* Files in the index are (conceptually) partitioned into workspace and non-workspace (external) files. * Files in the index are (conceptually) partitioned into workspace and non-workspace (external) files.
* Clients can obtain instances of IIndexFileLocation implementations from {@link IndexLocationFactory} * Clients can obtain instances of IIndexFileLocation implementations from {@link IndexLocationFactory}
* <p>
* This interface is not intended to be implemented by clients.
* </p>
* <p>
* <strong>EXPERIMENTAL</strong>. This class or 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>
* *
* @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 IIndexFileLocation { public interface IIndexFileLocation {

View file

@ -1,5 +1,5 @@
/******************************************************************************* /*******************************************************************************
* Copyright (c) 2008 Wind River Systems, Inc. and others. * Copyright (c) 2008, 2009 Wind River Systems, Inc. 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,8 @@ import org.eclipse.cdt.internal.core.index.IndexFileSet;
/** /**
* File set for index files. Can be used to filter file-local bindings. * File set for index files. Can be used to filter file-local bindings.
* @since 5.0 * @since 5.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 IIndexFileSet { public interface IIndexFileSet {
IIndexFileSet EMPTY = new IndexFileSet(); IIndexFileSet EMPTY = new IndexFileSet();

View file

@ -1,5 +1,5 @@
/******************************************************************************* /*******************************************************************************
* Copyright (c) 2006, 2008 Wind River Systems, Inc. and others. * Copyright (c) 2006, 2009 Wind River Systems, Inc. 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,7 @@ import org.eclipse.core.runtime.CoreException;
/** /**
* Interface for an include directive stored in the index. * Interface for an include directive stored in the index.
* *
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients. * @noimplement This interface is not intended to be implemented by clients.
* @since 4.0 * @since 4.0
*/ */

View file

@ -1,5 +1,5 @@
/******************************************************************************* /*******************************************************************************
* Copyright (c) 2006 Wind River Systems, Inc. and others. * Copyright (c) 2006, 2009 Wind River Systems, Inc. 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,17 +16,10 @@ import org.eclipse.cdt.core.dom.ILinkage;
/** /**
* Represents the linkage of a name in the index. * Represents the linkage of a name in the index.
* <p>
* This interface is not intended to be implemented by clients.
* </p>
* <p>
* <strong>EXPERIMENTAL</strong>. This class or 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 IIndexLinkage extends ILinkage { public interface IIndexLinkage extends ILinkage {
/** /**

View file

@ -1,5 +1,5 @@
/******************************************************************************* /*******************************************************************************
* Copyright (c) 2006, 2007 Symbian Software Ltd. and others. * Copyright (c) 2006, 2009 Symbian Software Ltd. 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
@ -17,6 +17,9 @@ package org.eclipse.cdt.core.index;
* *
* Internal to IIndexFragment a mechanism for converting between the string location format used * Internal to IIndexFragment a mechanism for converting between the string location format used
* and the URI world is needed. This interface represents that mechanism. * and the URI world is needed. This interface represents that mechanism.
*
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
*/ */
public interface IIndexLocationConverter { public interface IIndexLocationConverter {
/** /**

View file

@ -1,5 +1,5 @@
/******************************************************************************* /*******************************************************************************
* Copyright (c) 2006, 2008 Wind River Systems, Inc. and others. * Copyright (c) 2006, 2009 Wind River Systems, Inc. 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
@ -17,17 +17,10 @@ import org.eclipse.core.runtime.CoreException;
/** /**
* Represents a macro stored in the index. * Represents a macro stored in the index.
* <p>
* This interface is not intended to be implemented by clients.
* </p>
* <p>
* <strong>EXPERIMENTAL</strong>. This class or 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 IIndexMacro extends IMacroBinding, IIndexBinding { public interface IIndexMacro extends IMacroBinding, IIndexBinding {

View file

@ -1,5 +1,5 @@
/******************************************************************************* /*******************************************************************************
* Copyright (c) 2008 Wind River Systems, Inc. and others. * Copyright (c) 2008, 2009 Wind River Systems, Inc. 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 @@ package org.eclipse.cdt.core.index;
* Represents a binding for all macros with the same name. When you try to adapt a macro binding in an index * Represents a binding for all macros with the same name. When you try to adapt a macro binding in an index
* you'll get the container as a result. * you'll get the container as a result.
* @since 5.0 * @since 5.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 IIndexMacroContainer extends IIndexBinding { public interface IIndexMacroContainer extends IIndexBinding {

View file

@ -1,5 +1,5 @@
/******************************************************************************* /*******************************************************************************
* Copyright (c) 2006, 2008 Wind River Systems, Inc. and others. * Copyright (c) 2006, 2009 Wind River Systems, Inc. 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,15 +21,9 @@ import org.eclipse.core.runtime.IProgressMonitor;
/** /**
* Starting point for working with the index. The manager can be obtained via * Starting point for working with the index. The manager can be obtained via
* {@link CCorePlugin#getIndexManager()}. * {@link CCorePlugin#getIndexManager()}.
* <p> *
* This interface is not intended to be implemented by clients. * @noextend This interface is not intended to be extended by clients.
* </p> * @noimplement This interface is not intended to be implemented by clients.
* <p>
* <strong>EXPERIMENTAL</strong>. This class or 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
*/ */

View file

@ -1,5 +1,5 @@
/******************************************************************************* /*******************************************************************************
* Copyright (c) 2006, 2008 Wind River Systems, Inc. and others. * Copyright (c) 2006, 2009 Wind River Systems, Inc. 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,17 +19,11 @@ import org.eclipse.core.runtime.CoreException;
/** /**
* Interface for all the names in the index. These constitute either a * Interface for all the names in the index. These constitute either a
* declaration or a reference. * declaration or a reference.
* <p>
* This interface is not intended to be implemented by clients.
* </p>
* <p>
* <strong>EXPERIMENTAL</strong>. This class or 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 IIndexName extends IName { public interface IIndexName extends IName {
IIndexName[] EMPTY_ARRAY= {}; IIndexName[] EMPTY_ARRAY= {};

View file

@ -12,13 +12,9 @@ package org.eclipse.cdt.core.index;
/** /**
* IndexChangeEvents describe changes to the state of the indexer. * IndexChangeEvents describe changes to the state of the indexer.
* <p>
* <strong>EXPERIMENTAL</strong>. This class or 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>
* *
* @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 IIndexerStateEvent { public interface IIndexerStateEvent {

View file

@ -1,5 +1,5 @@
/******************************************************************************* /*******************************************************************************
* Copyright (c) 2006, 2008 Symbian Software Ltd. and others. * Copyright (c) 2006, 2009 Symbian Software Ltd. 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
@ -33,13 +33,10 @@ import org.eclipse.core.runtime.Path;
* Factory for obtaining instances of IIndexFileLocation for workspace or external files, and * Factory for obtaining instances of IIndexFileLocation for workspace or external files, and
* some utility methods for going in the opposite direction. * some utility methods for going in the opposite direction.
* *
* <strong>EXPERIMENTAL</strong>. This class or 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 class is not intended to be subclassed by clients.
* @noinstantiate This class is not intended to be instantiated by clients.
*/ */
public class IndexLocationFactory { public class IndexLocationFactory {
/** /**

View file

@ -1,5 +1,5 @@
/******************************************************************************* /*******************************************************************************
* Copyright (c) 2007 Symbian Software Systems and others. * Copyright (c) 2007, 2009 Symbian 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
@ -29,6 +29,9 @@ import org.eclipse.core.runtime.Platform;
* <br><br> * <br><br>
* If your requirements are very simple, then {@link ExternalExportProjectProvider} may * If your requirements are very simple, then {@link ExternalExportProjectProvider} may
* be sufficient for direct usage. * be sufficient for direct usage.
*
* @noextend This interface is not intended to be extended by clients.
* @noimplement This interface is not intended to be implemented by clients.
*/ */
public interface IExportProjectProvider { public interface IExportProjectProvider {
/** /**

View file

@ -1,5 +1,5 @@
/******************************************************************************* /*******************************************************************************
* Copyright (c) 2007 Symbian Software Systems and others. * Copyright (c) 2007, 2009 Symbian 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,10 @@ package org.eclipse.cdt.core.index.export;
import org.eclipse.osgi.util.NLS; import org.eclipse.osgi.util.NLS;
/**
* @noextend This interface is not intended to be extended by clients.
* @noinstantiate This class is not intended to be instantiated by clients.
*/
public class Messages extends NLS { public class Messages extends NLS {
private static final String BUNDLE_NAME = "org.eclipse.cdt.core.index.export.messages"; //$NON-NLS-1$ private static final String BUNDLE_NAME = "org.eclipse.cdt.core.index.export.messages"; //$NON-NLS-1$
public static String CLIUtil_OptionParametersMismatch; public static String CLIUtil_OptionParametersMismatch;

View file

@ -1,5 +1,5 @@
/******************************************************************************* /*******************************************************************************
* Copyright (c) 2007 Symbian Software Systems and others. * Copyright (c) 2007, 2009 Symbian 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
@ -16,7 +16,10 @@ import org.eclipse.core.runtime.CoreException;
/** /**
* An IIndexProvider implementation provides additional indexing information for CDT projects * An IIndexProvider implementation provides additional indexing information for CDT projects
* This interface only exists to hold commonality from sub-interfaces. * This interface only exists to hold commonality from sub-interfaces.
* @since 4.0.0 *
* @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 IIndexProvider { public interface IIndexProvider {
/** /**

View file

@ -15,7 +15,10 @@ import org.eclipse.cdt.core.settings.model.ICConfigurationDescription;
/** /**
* This interface is intended for ISVs to implement when plugging a mechanism * This interface is intended for ISVs to implement when plugging a mechanism
* for read-only/off-line indexes into the CIndex.ReadOnlyPDOMProvider extension point element. * for read-only/off-line indexes into the CIndex.ReadOnlyPDOMProvider extension point element.
* @since 4.0.0 *
* @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 IReadOnlyPDOMProvider extends IIndexProvider { public interface IReadOnlyPDOMProvider extends IIndexProvider {
/** /**