From d37532a23c3974929001f439d6ce432dc36134d2 Mon Sep 17 00:00:00 2001 From: Sergey Prigogin Date: Sun, 6 Mar 2011 23:54:12 +0000 Subject: [PATCH] Comment adjustment. --- .../cdt/core/index/provider/IIndexProvider.java | 15 ++++++++------- .../cdt/core/index/provider/IPDOMDescriptor.java | 8 ++++---- .../index/provider/IIndexFragmentProvider.java | 13 ++++++++----- 3 files changed, 20 insertions(+), 16 deletions(-) diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/index/provider/IIndexProvider.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/index/provider/IIndexProvider.java index dc28f06ae30..2a5278f16ed 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/index/provider/IIndexProvider.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/index/provider/IIndexProvider.java @@ -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. *

- * 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; diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/index/provider/IPDOMDescriptor.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/index/provider/IPDOMDescriptor.java index 7a97612aee2..30308a6413d 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/index/provider/IPDOMDescriptor.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/index/provider/IPDOMDescriptor.java @@ -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 */ diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/index/provider/IIndexFragmentProvider.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/index/provider/IIndexFragmentProvider.java index e2eb000a2c6..18b46b01c4f 100644 --- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/index/provider/IIndexFragmentProvider.java +++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/internal/core/index/provider/IIndexFragmentProvider.java @@ -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. *

- * + * *

* IndexProviders are registered via the extension point * org.eclipse.cdt.core.CIndex @@ -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; }