Skip to content

Commit

Permalink
Merge pull request #2511 from Tyriar/marker_doc
Browse files Browse the repository at this point in the history
Clarify marker API docs
  • Loading branch information
Tyriar authored Oct 25, 2019
2 parents 1c72a66 + dac2da0 commit 974c721
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions typings/xterm.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,8 @@ declare module 'xterm' {

/**
* 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 {
/**
Expand All @@ -339,7 +340,8 @@ declare module 'xterm' {
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;
}
Expand Down

0 comments on commit 974c721

Please sign in to comment.