mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-07-27 19:05:38 +02:00
Code Issues Wiki Activity

Improved javadoc of IASTNode.getNodeLocations().

Browse source
This commit is contained in:
Markus Schorn 2008-10-22 14:22:15 +00:00
parent 6724c62308
commit 38fae876ab
1 changed files with 6 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -34,7 +34,7 @@ public interface IASTNode {
/** /**
* Get the location of this node. In cases not involving macro expansions, * Get the location of this node. In cases not involving macro expansions,
* the IASTNodeLocation [] result will only have one element in it, and it * the IASTNodeLocation [] result will only have one element in it, and it
* will be an IASTFileLocation or sub-interface. * will be an IASTFileLocation.
* *
* Where the node is completely generated within a macro expansion, * Where the node is completely generated within a macro expansion,
* IASTNodeLocation [] result will have one element in it, and it will be an * IASTNodeLocation [] result will have one element in it, and it will be an
@ -44,7 +44,11 @@ public interface IASTNode {
* of the macro expansion again) result in an IASTNodeLocation [] result * of the macro expansion again) result in an IASTNodeLocation [] result
* that is of length > 1. * that is of length > 1.
* *
* @return <code>IASTNodeLocation []</code> * We do not provide meaningful node locations for nested macro references
* (see {@link IASTPreprocessorMacroExpansion#getNestedMacroReferences()}).
* For those, the file location of the enclosing explicit macro reference is
* returned. You can however compute their image-location using
* {@link IASTName#getImageLocation()}
*/ */
public IASTNodeLocation[] getNodeLocations(); public IASTNodeLocation[] getNodeLocations();