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 adjustments.

Browse source
This commit is contained in:
Sergey Prigogin 2011-03-07 19:08:26 +00:00
parent 74f76e1c9a
commit 2550819036
1 changed files with 15 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTNode.java
View file

@ -27,14 +27,14 @@ public interface IASTNode {
*/ */
public enum CopyStyle { public enum CopyStyle {
/** /**
* Copy without location, this copy is independed of the index an can be shared. * Copy without location, this copy is independent of the index and can be shared.
*/ */
withoutLocations, withoutLocations,
/** /**
* The copied node has a {@link IASTCopyLocation} linking the copy to the origianl node. If the index * The copied node has a {@link IASTCopyLocation} linking the copy to the original node.
* was supplied creating the original AST, the caller has to hold a read lock on it. The returned copy * If the index was supplied creating the original AST, the caller has to hold a read lock
* is valid only while the read lock is being held and should not be accessed after releasing the * on it. The returned copy is valid only while the read lock is being held and should
* lock. * not be accessed after releasing the lock.
*/ */
withLocations withLocations
} }
@ -71,12 +71,13 @@ public interface IASTNode {
public IASTNodeLocation[] getNodeLocations(); public IASTNodeLocation[] getNodeLocations();
/** /**
* Computes a file location for the node. When the node actually resides in a macro-expansion the * Computes a file location for the node. When the node actually resides in a macro-expansion
* location of the expansion is returned. In case the node spans multiple files the location will * the location of the expansion is returned. In case the node spans multiple files the location
* be in a common root file and will contain the appropriate include directives. * will be in a common root file and will contain the appropriate include directives.
* <p> * <p>
* The method may return <code>null</code> in case the node does not have a file-location. This is * The method may return <code>null</code> in case the node does not have a file-location. This
* for instance the case for built-in macro names or empty names for anonymous type declarations. * is for instance the case for built-in macro names or empty names for anonymous type
* declarations.
* *
* @return the mapped file location or <code>null</code>. * @return the mapped file location or <code>null</code>.
*/ */
@ -186,7 +187,8 @@ public interface IASTNode {
* part of a translation unit. * part of a translation unit.
* @since 5.1 * @since 5.1
*/ */
public IToken getLeadingSyntax() throws ExpansionOverlapsBoundaryException, UnsupportedOperationException; public IToken getLeadingSyntax() throws ExpansionOverlapsBoundaryException,
UnsupportedOperationException;
/** /**
* Returns the tokens that can be found between this node and its right sibling (or the * Returns the tokens that can be found between this node and its right sibling (or the
@ -266,8 +268,8 @@ public interface IASTNode {
* Implicit name nodes are not copied, instead they can be regenerated if required. * Implicit name nodes are not copied, instead they can be regenerated if required.
* *
* @param style * @param style
* {@link CopyStyle} create a copy with or without locations. Please see {@link CopyStyle} for * {@link CopyStyle} create a copy with or without locations. Please see
* restrictions on copies with Locations. * {@link CopyStyle} for restrictions on copies with Locations.
* @since 5.3 * @since 5.3
* @throws UnsupportedOperationException * @throws UnsupportedOperationException
* if this node or one of its descendants does not support copying * if this node or one of its descendants does not support copying