Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndrew Ferguson2008-02-21 17:19:45 +0000
committerAndrew Ferguson2008-02-21 17:19:45 +0000
commit65ff00c6073da67ab0ae5e474dea87c9acf25a93 (patch)
tree814245a62430aecc8ca7416a6677888b60a1f3ec /core/org.eclipse.cdt.core/parser
parentd236e380c727a9dc401b9447ff4e6ea6b1d147fd (diff)
downloadorg.eclipse.cdt-65ff00c6073da67ab0ae5e474dea87c9acf25a93.tar.gz
org.eclipse.cdt-65ff00c6073da67ab0ae5e474dea87c9acf25a93.tar.xz
org.eclipse.cdt-65ff00c6073da67ab0ae5e474dea87c9acf25a93.zip
Fix documentation, schema fix is contributed by Tim Kelly (Nokia)
Diffstat (limited to 'core/org.eclipse.cdt.core/parser')
-rw-r--r--core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/index/URIRelativeLocationConverter.java11
1 files changed, 7 insertions, 4 deletions
diff --git a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/index/URIRelativeLocationConverter.java b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/index/URIRelativeLocationConverter.java
index c45e16dab10..a562589bb5a 100644
--- a/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/index/URIRelativeLocationConverter.java
+++ b/core/org.eclipse.cdt.core/parser/org/eclipse/cdt/core/index/URIRelativeLocationConverter.java
@@ -17,20 +17,23 @@ import org.eclipse.core.filesystem.URIUtil;
/**
* A IIndexLocationConverter for converting relative paths within an index, by prefixing them
- * with the supplied base URI
+ * with the supplied base URI.<p>
+ * <em>Note: The supplied base URI must end with a forward slash</em>
* <br>
* This location converter is internal-representation-compatible with ResourceContainerRelativeLocationConverter
+ * @since 4.0
*/
/*
- * Internal representation is uri relative path (non encoded form)
+ * The associated internal PDOM representation is the relative path (non encoded form)
*/
public class URIRelativeLocationConverter implements IIndexLocationConverter {
private URI baseURI;
/**
* Constructs an URIRelativeLocationConverter which will relative paths
- * by prefixing the supplied base URI
- * @param baseURI
+ * by prefixing the supplied base URI.
+ * @param baseURI the URI which will form the absolute base that relative paths
+ * are concatenated to. <em>Note: It must end with a forward slash</em>.
*/
public URIRelativeLocationConverter(URI baseURI) {
this.baseURI = baseURI;

Back to the top