mirror of
https://github.com/eclipse-cdt/cdt
synced 2025-08-01 05:15:43 +02:00
Cosmetics.
This commit is contained in:
parent
3649ffac46
commit
bdde88fd2a
3 changed files with 47 additions and 44 deletions
|
@ -15,8 +15,7 @@ import org.eclipse.cdt.core.dom.IName;
|
||||||
import org.eclipse.core.runtime.CoreException;
|
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.
|
|
||||||
*
|
*
|
||||||
* @since 4.0
|
* @since 4.0
|
||||||
*
|
*
|
||||||
|
@ -43,15 +42,14 @@ public interface IIndexName extends IName {
|
||||||
public int getNodeLength();
|
public int getNodeLength();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the name of the definition that contains this name.
|
* Returns the name of the definition that contains this name. May return {@code null}.
|
||||||
* May return <code>null</code>.
|
|
||||||
* Currently this is implemented for function and method definitions, only.
|
* Currently this is implemented for function and method definitions, only.
|
||||||
*/
|
*/
|
||||||
public IIndexName getEnclosingDefinition() throws CoreException;
|
public IIndexName getEnclosingDefinition() throws CoreException;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the names of the references contained in this definition.
|
* Returns the names of the references contained in this definition.
|
||||||
* Returns <code>null</code>, if the name is not a definition.
|
* Returns {@code null}, if the name is not a definition.
|
||||||
*
|
*
|
||||||
* Currently the method works with function definitions, only.
|
* Currently the method works with function definitions, only.
|
||||||
*/
|
*/
|
||||||
|
@ -65,7 +63,8 @@ public interface IIndexName extends IName {
|
||||||
/**
|
/**
|
||||||
* Returns whether this name potentially denotes a polymorphic method call. This is the case
|
* Returns whether this name potentially denotes a polymorphic method call. This is the case
|
||||||
* when the name is not qualified and denotes a method call and the method is accessed via a
|
* when the name is not qualified and denotes a method call and the method is accessed via a
|
||||||
* pointer or a reference to an object. <p>
|
* pointer or a reference to an object.
|
||||||
|
* <p>
|
||||||
* No checks are performed whether the method is actually virtual or not.
|
* No checks are performed whether the method is actually virtual or not.
|
||||||
*/
|
*/
|
||||||
public boolean couldBePolymorphicMethodCall() throws CoreException;
|
public boolean couldBePolymorphicMethodCall() throws CoreException;
|
||||||
|
@ -79,7 +78,8 @@ public interface IIndexName extends IName {
|
||||||
/**
|
/**
|
||||||
* Returns whether this name is a read-reference to a variable or field.
|
* Returns whether this name is a read-reference to a variable or field.
|
||||||
* The notion of a read-reference may not strictly reflect what your compiler generates,
|
* The notion of a read-reference may not strictly reflect what your compiler generates,
|
||||||
* heuristics may be used. <p>
|
* heuristics may be used.
|
||||||
|
* <p>
|
||||||
* For pointers and arrays the access to the pointer itself is tracked, rather than considering
|
* For pointers and arrays the access to the pointer itself is tracked, rather than considering
|
||||||
* the target of the pointer.
|
* the target of the pointer.
|
||||||
*/
|
*/
|
||||||
|
@ -88,7 +88,8 @@ public interface IIndexName extends IName {
|
||||||
/**
|
/**
|
||||||
* Returns whether this name is a write-reference to a variable or field.
|
* Returns whether this name is a write-reference to a variable or field.
|
||||||
* The notion of a write-reference may not strictly reflect what your compiler generates,
|
* The notion of a write-reference may not strictly reflect what your compiler generates,
|
||||||
* heuristics may be used. <p>
|
* heuristics may be used.
|
||||||
|
* <p>
|
||||||
* For pointers and arrays the access to the pointer itself is tracked, rather than considering
|
* For pointers and arrays the access to the pointer itself is tracked, rather than considering
|
||||||
* the target of the pointer.
|
* the target of the pointer.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -33,8 +33,8 @@ abstract public class IndexFilter {
|
||||||
public static final IndexFilter C_DECLARED_OR_IMPLICIT= getDeclaredBindingFilter(ILinkage.C_LINKAGE_ID, true);
|
public static final IndexFilter C_DECLARED_OR_IMPLICIT= getDeclaredBindingFilter(ILinkage.C_LINKAGE_ID, true);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get an IndexFilter that filters out bindings from linkages other than that
|
* Get an IndexFilter that filters out bindings from linkages other than that specified.
|
||||||
* specified
|
*
|
||||||
* @param linkageID the id of the linkage whose bindings should be retained
|
* @param linkageID the id of the linkage whose bindings should be retained
|
||||||
* @return an IndexFilter instance
|
* @return an IndexFilter instance
|
||||||
*/
|
*/
|
||||||
|
@ -48,8 +48,9 @@ abstract public class IndexFilter {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Get an IndexFilter that filters out bindings without declarations and those
|
* Get an IndexFilter that filters out bindings without declarations and those from linkages
|
||||||
* from linkages other than that specified.
|
* other than that specified.
|
||||||
|
*
|
||||||
* @param linkageID the id of the linkage whose bindings should be retained, or -1
|
* @param linkageID the id of the linkage whose bindings should be retained, or -1
|
||||||
* to accept all linkages.
|
* to accept all linkages.
|
||||||
* @return an IndexFilter instance
|
* @return an IndexFilter instance
|
||||||
|
@ -61,6 +62,7 @@ abstract public class IndexFilter {
|
||||||
/**
|
/**
|
||||||
* Get an IndexFilter that filters out bindings without declarations and those
|
* Get an IndexFilter that filters out bindings without declarations and those
|
||||||
* from linkages other than that specified.
|
* from linkages other than that specified.
|
||||||
|
*
|
||||||
* @param linkageID the id of the linkage whose bindings should be retained, or -1
|
* @param linkageID the id of the linkage whose bindings should be retained, or -1
|
||||||
* to accept all linkages.
|
* to accept all linkages.
|
||||||
* @return an IndexFilter instance
|
* @return an IndexFilter instance
|
||||||
|
@ -73,6 +75,7 @@ abstract public class IndexFilter {
|
||||||
/**
|
/**
|
||||||
* Returns whether or not to include objects of the given linkage in the query.
|
* Returns whether or not to include objects of the given linkage in the query.
|
||||||
* @see IIndex#findBindings(java.util.regex.Pattern, boolean, IndexFilter, org.eclipse.core.runtime.IProgressMonitor)
|
* @see IIndex#findBindings(java.util.regex.Pattern, boolean, IndexFilter, org.eclipse.core.runtime.IProgressMonitor)
|
||||||
|
*
|
||||||
* @param linkage a linkage to be tested
|
* @param linkage a linkage to be tested
|
||||||
* @return whether to include objects of the given linkage in the query.
|
* @return whether to include objects of the given linkage in the query.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -126,5 +126,4 @@ public class CModelUtil {
|
||||||
return true;
|
return true;
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
Loading…
Add table
Reference in a new issue