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

Javadoc for IASTNode.getFileLocation()

This commit is contained in:
Markus Schorn 2007-11-13 08:32:41 +00:00
parent 6fb649fa9e
commit 22a3a7bba8

View file

@ -47,9 +47,14 @@ public interface IASTNode {
public IASTNodeLocation[] getNodeLocations(); public IASTNodeLocation[] getNodeLocations();
/** /**
* Get the location of the node as a file. * Computes a file location for the node. When the node actually resides in a macro-expansion the
* location of the expansion is returned. In case the node spans multiple files the location will
* be in a common root file and will contain the appropriate include directives.
* <p>
* The method may return <code>null</code> in case the node does not have a file-location. This is
* for instance the case for built-in macro names or empty names for anonymous type declarations.
* *
* @return <code>IASTFileLocation</code> * @return the mapped file location or <code>null</code>.
*/ */
public IASTFileLocation getFileLocation(); public IASTFileLocation getFileLocation();