mirror of
https://github.com/eclipse-cdt/cdt
synced 2025-04-29 19:45:01 +02:00
Comment adjustment.
This commit is contained in:
Sergey Prigogin
parent
341c8d3d01
commit
3802443e35
1 changed files with 65 additions and 55 deletions
|
|
@ -58,23 +58,25 @@ public interface IIndexFragment {
|
|||
final int FIND_ALL_OCCURRENCES = IIndex.FIND_ALL_OCCURRENCES;
|
||||
|
||||
/**
|
||||
* Property key for the fragment ID. The fragment ID should uniquely identify the fragments usage within
|
||||
* a logical index.
|
||||
* Property key for the fragment ID. The fragment ID should uniquely identify the fragments
|
||||
* usage within a logical index.
|
||||
* @since 4.0
|
||||
*/
|
||||
public static final String PROPERTY_FRAGMENT_ID= "org.eclipse.cdt.internal.core.index.fragment.id"; //$NON-NLS-1$
|
||||
|
||||
/**
|
||||
* Property key for the fragment format ID. The fragment format ID should uniquely identify a format of an index fragment
|
||||
* up to version information. That is, as a particular format changes version its ID should remain the same.
|
||||
* Property key for the fragment format ID. The fragment format ID should uniquely identify
|
||||
* a format of an index fragment up to version information. That is, as a particular format
|
||||
* changes version its ID should remain the same.
|
||||
* @since 4.0.1
|
||||
*/
|
||||
public static final String PROPERTY_FRAGMENT_FORMAT_ID= "org.eclipse.cdt.internal.core.index.fragment.format.id"; //$NON-NLS-1$
|
||||
|
||||
/**
|
||||
* Property key for the fragment format's version. Version numbers belonging to the same format (identified by format ID) should be
|
||||
* comparable with each other. The version scheme exposed should be compatible with the OSGi framework's
|
||||
* version scheme - i.e. it should be successfully parsed by org.osgi.framework.Version.parseVersion(String). A null value
|
||||
* Property key for the fragment format's version. Version numbers belonging to the same format
|
||||
* (identified by format ID) should be comparable with each other. The version scheme exposed
|
||||
* should be compatible with the OSGi framework's version scheme - i.e. it should be
|
||||
* successfully parsed by org.osgi.framework.Version.parseVersion(String). A null value
|
||||
* for this property is interpreted as Version(0.0.0)
|
||||
* @since 4.0.1
|
||||
*/
|
||||
|
|
@ -92,7 +94,8 @@ public interface IIndexFragment {
|
|||
* This method returns files without content, also.
|
||||
* @param linkageID the id of the linkage in which the file has been parsed.
|
||||
* @param location the IIndexFileLocation representing the location of the file
|
||||
* @return the file for the location, or <code>null</code> if the file is not present in the index
|
||||
* @return the file for the location, or <code>null</code> if the file is not present in
|
||||
* the index
|
||||
* @throws CoreException
|
||||
*/
|
||||
IIndexFragmentFile getFile(int linkageID, IIndexFileLocation location) throws CoreException;
|
||||
|
|
@ -101,7 +104,8 @@ public interface IIndexFragment {
|
|||
* Returns the files in all linkages for the given location.
|
||||
* This method may only return files that are actually managed by this fragment.
|
||||
* @param location the IIndexFileLocation representing the location of the file
|
||||
* @return the file for the location, or <code>null</code> if the file is not present in the index
|
||||
* @return the file for the location, or <code>null</code> if the file is not present in
|
||||
* the index
|
||||
* @throws CoreException
|
||||
*/
|
||||
IIndexFragmentFile[] getFiles(IIndexFileLocation location) throws CoreException;
|
||||
|
|
@ -135,11 +139,14 @@ public interface IIndexFragment {
|
|||
IIndexFragmentBinding findBinding(IASTName astName) throws CoreException;
|
||||
|
||||
/**
|
||||
* Searches for all bindings with qualified names that seen as an array of simple names match the given array
|
||||
* of patterns. In case a binding exists in multiple projects, no duplicate bindings are returned.
|
||||
* Searches for all bindings with qualified names that seen as an array of simple names match
|
||||
* the given array of patterns. In case a binding exists in multiple projects, no duplicate
|
||||
* bindings are returned.
|
||||
* You can search with an array of patterns that specifies a partial qualification only.
|
||||
* @param patterns an array of patterns the names of the qualified name of the bindings have to match.
|
||||
* @param isFullyQualified if <code>true</code>, the array of pattern specifies the fully qualified name
|
||||
* @param patterns an array of patterns the names of the qualified name of the bindings have
|
||||
* to match.
|
||||
* @param isFullyQualified if <code>true</code>, the array of pattern specifies the fully
|
||||
* qualified name
|
||||
* @param filter a filter that allows for skipping parts of the index
|
||||
* @param monitor a monitor to report progress, may be <code>null</code>
|
||||
* @return an array of bindings matching the pattern
|
||||
|
|
@ -172,10 +179,11 @@ public interface IIndexFragment {
|
|||
IIndexFragmentBinding[] findBindings(char[][] names, IndexFilter filter, IProgressMonitor monitor) throws CoreException;
|
||||
|
||||
/**
|
||||
* Searches for all names that resolve to the given binding. You can limit the result to references, declarations
|
||||
* or definitions, or a combination of those.
|
||||
* Searches for all names that resolve to the given binding. You can limit the result to
|
||||
* references, declarations or definitions, or a combination of those.
|
||||
* @param binding a binding for which names are searched for
|
||||
* @param flags a combination of {@link #FIND_DECLARATIONS}, {@link #FIND_DEFINITIONS} and {@link #FIND_REFERENCES}
|
||||
* @param flags a combination of {@link #FIND_DECLARATIONS}, {@link #FIND_DEFINITIONS} and
|
||||
* {@link #FIND_REFERENCES}
|
||||
* @return an array of names
|
||||
* @throws CoreException
|
||||
*/
|
||||
|
|
@ -232,14 +240,16 @@ public interface IIndexFragment {
|
|||
IIndexLinkage[] getLinkages();
|
||||
|
||||
/**
|
||||
* Read the named property in this fragment. All fragments are expected to return a non-null value for
|
||||
* Read the named property in this fragment. All fragments are expected to return a non-null
|
||||
* value for
|
||||
* <ul>
|
||||
* <li>PROPERTY_FRAGMENT_ID</li>
|
||||
* <li>PROPERTY_FRAGMENT_FORMAT_ID</li>
|
||||
* <li>PROPERTY_FRAGMENT_FORMAT_VERSION</li>
|
||||
* </ul>
|
||||
* @param propertyName a case-sensitive identifier for a property, or null
|
||||
* @return the value associated with the key, or null if either no such property is set, or the specified key was null
|
||||
* @return the value associated with the key, or null if either no such property is set,
|
||||
* or the specified key was null
|
||||
* @throws CoreException
|
||||
* @see IIndexFragment#PROPERTY_FRAGMENT_ID
|
||||
* @see IIndexFragment#PROPERTY_FRAGMENT_FORMAT_ID
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue