mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-04-29 19:45:01 +02:00
Code Issues Wiki Activity

Comment adjustment.

Browse source
This commit is contained in:
Sergey Prigogin 2011-03-06 23:54:12 +00:00
parent 7d376a5e01
commit d37532a23c
3 changed files with 20 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/index/provider/IIndexProvider.java
View file

@ -6,7 +6,7 @@
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Andrew Ferguson (Symbian) - Initial implementation
* Andrew Ferguson (Symbian) - Initial implementation
*******************************************************************************/
package org.eclipse.cdt.core.index.provider;
@ -16,19 +16,20 @@ import org.eclipse.core.runtime.CoreException;
/**
* An IIndexProvider implementation provides additional indexing information for CDT projects
* This interface only exists to hold commonality from sub-interfaces.
*
*
* @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 {
/**
* This method is called to attach the index provider to the project specified. If the provider determines that it doesn't
* and will never provide indexes for the specified project, then it should return false to opt-out of being queried for
* that project.
* This method is called to attach the index provider to the project specified. If the provider
* determines that it doesn't and will never provide indexes for the specified project, then it
* should return false to opt-out of being queried for that project.
* <p>
* The method will only be called once per project per eclipse session. This method will be called when a project is deleted
* and a new project of the same name added. It also may be called lazily (at the point of first logical index use).
* The method will only be called once per project per eclipse session. This method will be
* called when a project is deleted and a new project of the same name added. It also may be
* called lazily (at the point of first logical index use).
* @param project
*/
public boolean providesFor(ICProject project) throws CoreException;

8
core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/index/provider/IPDOMDescriptor.java
View file

@ -6,7 +6,7 @@
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Andrew Ferguson (Symbian) - Initial implementation
* Andrew Ferguson (Symbian) - Initial implementation
*******************************************************************************/
package org.eclipse.cdt.core.index.provider;
@ -15,7 +15,7 @@ import org.eclipse.core.runtime.IPath;
/**
* Describes a PDOM format file in the local file system.
* @since 4.0.0
* @since 4.0
*/
public interface IPDOMDescriptor {
/**
@ -24,10 +24,10 @@ public interface IPDOMDescriptor {
* @return an absolute location of an existing file
*/
IPath getLocation();
/**
* An index location converter suitable of translating the internal
* formatted path representations to index locations representing the
* formatted path representations to index locations representing the
* current content location.
* @return an index location converter
*/

13
core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/index/provider/IIndexFragmentProvider.java
View file

@ -6,7 +6,7 @@
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Andrew Ferguson (Symbian) - Initial implementation
* Andrew Ferguson (Symbian) - Initial implementation
*******************************************************************************/
package org.eclipse.cdt.internal.core.index.provider;
@ -19,7 +19,7 @@ import org.eclipse.core.runtime.CoreException;
* The ICProject IIndex is a logical index composed of potentially many
* IIndexFragments. An IIndexFragmentProvider is a source of IIndexFragments.
* <p>
*
*
* <p>
* IndexProviders are registered via the extension point
* <code>org.eclipse.cdt.core.CIndex</code>
@ -27,9 +27,12 @@ import org.eclipse.core.runtime.CoreException;
*/
public interface IIndexFragmentProvider extends IIndexProvider {
/**
* Returns an array of IIndexFragment objects to add to the specified {@link ICConfigurationDescription}
* Returns an array of IIndexFragment objects to add to the specified
* {@link ICConfigurationDescription}.
*
* @param project
* @return an array of IIndexFragment objects to add to the specified {@link ICConfigurationDescription}
* @return an array of IIndexFragment objects to add to the specified
* {@link ICConfigurationDescription}
*/
IIndexFragment[] getIndexFragments(ICConfigurationDescription config) throws CoreException;
IIndexFragment[] getIndexFragments(ICConfigurationDescription config) throws CoreException;
}