mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-06-08 18:26:01 +02:00
Code Issues Wiki Activity

Improved javadoc for position tracker API.

Browse source
This commit is contained in:
Markus Schorn 2006-07-05 09:26:04 +00:00
parent 8ea9103fcf
commit dbd71f73a5
2 changed files with 9 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/IPositionConverter.java
View file

@ -21,13 +21,15 @@ import org.eclipse.jface.text.Position;
* *
* As long as the underlying text of the character range has not been modified the * As long as the underlying text of the character range has not been modified the
* converted range will have the same underlying text. Insertions at the beginning * converted range will have the same underlying text. Insertions at the beginning
* or the end of the text do not added to the converted range. * or the end of the text are not added to the converted range.
* *
* An insertion inside the underlying text will increase the length of the converted * An insertion inside the underlying text will increase the length of the converted
* range, a deletion of one of the characters will decrease it. * range, a deletion of one of the characters will decrease it.
* *
* An deletion followed by an insertion without saving the file inbetween, will cancel * An deletion followed by an insertion without saving the file inbetween, will cancel
* the deletion as much as possible. * the deletion as far as possible.
*
* <p> This interface is not intended to be implemented by clients. </p>
*/ */
public interface IPositionConverter { public interface IPositionConverter {
@ -46,7 +48,6 @@ public interface IPositionConverter {
* @param historicPosition a range as found in the version of the file for which * @param historicPosition a range as found in the version of the file for which
* the converter was obtained. * the converter was obtained.
* @return a range suitable for the current text buffer of the file. * @return a range suitable for the current text buffer of the file.
*
*/ */
Position historicToActual(Position historicPosition); Position historicToActual(Position historicPosition);
} }

7
core/org.eclipse.cdt.core/src/org/eclipse/cdt/core/IPositionTrackerManager.java
View file

@ -16,11 +16,14 @@ import org.eclipse.core.runtime.IPath;
/** /**
* An interface to manage the position tracking. It allows for mapping character * An interface to manage the position tracking. It allows for mapping character
* offsets from a file previously stored on disk to the current offset. * offsets from a file previously stored on disk to the offset in the current document
* for the file.
*
* <p> This interface is not intended to be implemented by clients. </p>
*/ */
public interface IPositionTrackerManager { public interface IPositionTrackerManager {
/** /**
* Returns the position tracker suitable for mapping character offsets of the * Returns the position converter suitable for mapping character offsets of the
* given file/timestamp to the current version of it. * given file/timestamp to the current version of it.
* *
* @param file a file for which the position adapter is requested. * @param file a file for which the position adapter is requested.