Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKai Maetzel2004-06-21 16:21:45 +0000
committerKai Maetzel2004-06-21 16:21:45 +0000
commit500246df7e56aa088e4269881a8b62f4c281e2da (patch)
tree3a938a6c751cfec4a4150065a9c746daff1f6cf3
parentb12fd50071c766ec391197a0db9243dee403ab10 (diff)
downloadeclipse.platform.text-500246df7e56aa088e4269881a8b62f4c281e2da.tar.gz
eclipse.platform.text-500246df7e56aa088e4269881a8b62f4c281e2da.tar.xz
eclipse.platform.text-500246df7e56aa088e4269881a8b62f4c281e2da.zip
updated Javadoc
-rw-r--r--org.eclipse.text/src/org/eclipse/jface/text/IDocumentInformationMapping.java12
-rw-r--r--org.eclipse.text/src/org/eclipse/jface/text/IDocumentInformationMappingExtension.java8
2 files changed, 16 insertions, 4 deletions
diff --git a/org.eclipse.text/src/org/eclipse/jface/text/IDocumentInformationMapping.java b/org.eclipse.text/src/org/eclipse/jface/text/IDocumentInformationMapping.java
index 32f2f7be9..c025e223d 100644
--- a/org.eclipse.text/src/org/eclipse/jface/text/IDocumentInformationMapping.java
+++ b/org.eclipse.text/src/org/eclipse/jface/text/IDocumentInformationMapping.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -17,6 +17,14 @@ package org.eclipse.jface.text;
* can translate document information such as line numbers or character ranges given for the original into
* the corresponding information of the image and vice versa.
*
+ * In order to provided backward compatibility for clients of <code>IDocumentInformationMapping</code>, extension
+ * interfaces are used to provide a means of evolution. The following extension interfaces
+ * exist:
+ * <ul>
+ * <li> {@link org.eclipse.jface.text.IDocumentInformationMappingExtension} since version 3.0 extending the
+ * degree of detail of the mapping information.</li>
+ * </ul>
+ *
* @since 2.1
*/
public interface IDocumentInformationMapping {
@@ -44,7 +52,7 @@ public interface IDocumentInformationMapping {
* image document or <code>null</code> if there is no such region.
*
* @param imageRegion the region of the image document
- * @return the minimal region of the original document comprising the given region of the image document
+ * @return the minimal region of the original document comprising the given region of the image document or <code>null</code>
* @throws BadLocationException if <code>imageRegion</code> is not a valid region of the image document
*/
IRegion toOriginRegion(IRegion imageRegion) throws BadLocationException;
diff --git a/org.eclipse.text/src/org/eclipse/jface/text/IDocumentInformationMappingExtension.java b/org.eclipse.text/src/org/eclipse/jface/text/IDocumentInformationMappingExtension.java
index e22554af3..6981b3267 100644
--- a/org.eclipse.text/src/org/eclipse/jface/text/IDocumentInformationMappingExtension.java
+++ b/org.eclipse.text/src/org/eclipse/jface/text/IDocumentInformationMappingExtension.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -11,8 +11,12 @@
package org.eclipse.jface.text;
/**
- * Extension to <code>IDocumentInformationMapping</code>.
+ * Extension to {@link org.eclipse.jface.text.IDocumentInformationMapping}.
+ * <p>
+ * Extends the information available in the mapping by providing explicit access
+ * to the isomorphic portion of the basically homomorphic information mapping.
*
+ * @see org.eclipse.jface.text.IDocumentInformationMapping
* @since 3.0
*/
public interface IDocumentInformationMappingExtension {

Back to the top