Clarify marker API docs

This commit is contained in:
Daniel
2019-10-25 04:13:03 -07:00
parent 080188c468
commit dac2da05bf
+4 -2
View File
@@ -325,7 +325,8 @@ declare module 'xterm' {
/** /**
* Represents a specific line in the terminal that is tracked when scrollback * Represents a specific line in the terminal that is tracked when scrollback
* is trimmed and lines are added or removed. * is trimmed and lines are added or removed. This is a single line that may
* be part of a larger wrapped line.
*/ */
export interface IMarker extends IDisposable { export interface IMarker extends IDisposable {
/** /**
@@ -339,7 +340,8 @@ declare module 'xterm' {
readonly isDisposed: boolean; readonly isDisposed: boolean;
/** /**
* The actual line index in the buffer at this point in time. * The actual line index in the buffer at this point in time. This is set to
* -1 if the marker has been disposed.
*/ */
readonly line: number; readonly line: number;
} }