From 22a3a7bba88a2390677a0f806fdfff36eab3c7e8 Mon Sep 17 00:00:00 2001
From: Markus Schorn <markus.schorn@windriver.com>
Date: Tue, 13 Nov 2007 08:32:41 +0000
Subject: [PATCH] Javadoc for IASTNode.getFileLocation()

---
 .../parser/org/eclipse/cdt/core/dom/ast/IASTNode.java    | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTNode.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTNode.java
index 719daa4c9ba..dd61943458d 100644
--- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTNode.java
+++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/dom/ast/IASTNode.java
@@ -47,9 +47,14 @@ public interface IASTNode {
 	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();