From 38fae876ab1ce4bb9771079ab5b26d8d51bf49c3 Mon Sep 17 00:00:00 2001
From: Markus Schorn <markus.schorn@windriver.com>
Date: Wed, 22 Oct 2008 14:22:15 +0000
Subject: [PATCH] Improved javadoc of IASTNode.getNodeLocations().

---
 .../parser/org/eclipse/cdt/core/dom/ast/IASTNode.java     | 8 ++++++--
 1 file changed, 6 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 9bb7216d81c..73623dde8a5 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
@@ -34,7 +34,7 @@ public interface IASTNode {
 	/**
 	 * Get the location of this node. In cases not involving macro expansions,
 	 * 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,
 	 * 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
 	 * 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();