Fix more TomDoc references

This commit is contained in:
Matt Colyer
2013-08-22 16:47:48 -07:00
parent 8e2777ccc0
commit 0e8ec74662
5 changed files with 13 additions and 13 deletions

View File

@@ -4,7 +4,7 @@ _ = require 'underscore'
# Public: The `Cursor` class represents the little blinking line identifying where text can be inserted.
#
# Cursors have some metadata attached in the form of a {BufferMarker}.
# Cursors have some metadata attached in the form of a {StringMarker}.
module.exports =
class Cursor
_.extend @prototype, EventEmitter

View File

@@ -42,7 +42,7 @@ class DisplayBufferMarker
# Modifies the screen range of the display marker.
#
# screenRange - The new {Range} to use
# options - A hash of options matching those found in {BufferMarker.setRange}
# options - A hash of options matching those found in {StringMarker.setRange}
setScreenRange: (screenRange, options) ->
@setBufferRange(@displayBuffer.bufferRangeForScreenRange(screenRange), options)
@@ -55,7 +55,7 @@ class DisplayBufferMarker
# Modifies the buffer range of the display marker.
#
# screenRange - The new {Range} to use
# options - A hash of options matching those found in {BufferMarker.setRange}
# options - A hash of options matching those found in {StringMarker.setRange}
setBufferRange: (bufferRange, options) ->
@bufferMarker.setRange(bufferRange, options)
@@ -140,7 +140,7 @@ class DisplayBufferMarker
# Returns a {Boolean} indicating whether the marker has been destroyed. A marker
# can be invalid without being destroyed, in which case undoing the invalidating
# operation would restore the marker. Once a marker is destroyed by calling
# {BufferMarker.destroy}, no undo/redo operation can ever bring it back.
# {StringMarker.destroy}, no undo/redo operation can ever bring it back.
isDestroyed: ->
@bufferMarker.isDestroyed()

View File

@@ -474,7 +474,7 @@ class DisplayBuffer
# Constructs a new marker at the given screen range.
#
# range - The marker {Range} (representing the distance between the head and tail)
# options - Options to pass to the {BufferMarker} constructor
# options - Options to pass to the {StringMarker} constructor
#
# Returns a {Number} representing the new marker's ID.
markScreenRange: (args...) ->
@@ -484,7 +484,7 @@ class DisplayBuffer
# Constructs a new marker at the given buffer range.
#
# range - The marker {Range} (representing the distance between the head and tail)
# options - Options to pass to the {BufferMarker} constructor
# options - Options to pass to the {StringMarker} constructor
#
# Returns a {Number} representing the new marker's ID.
markBufferRange: (args...) ->
@@ -493,7 +493,7 @@ class DisplayBuffer
# Constructs a new marker at the given screen position.
#
# range - The marker {Range} (representing the distance between the head and tail)
# options - Options to pass to the {BufferMarker} constructor
# options - Options to pass to the {StringMarker} constructor
#
# Returns a {Number} representing the new marker's ID.
markScreenPosition: (screenPosition, options) ->
@@ -502,7 +502,7 @@ class DisplayBuffer
# Constructs a new marker at the given buffer position.
#
# range - The marker {Range} (representing the distance between the head and tail)
# options - Options to pass to the {BufferMarker} constructor
# options - Options to pass to the {StringMarker} constructor
#
# Returns a {Number} representing the new marker's ID.
markBufferPosition: (bufferPosition, options) ->

View File

@@ -827,7 +827,7 @@ class EditSession
destroyMarker: (args...) ->
@displayBuffer.destroyMarker(args...)
# {Delegates to: Buffer.getMarkerCount}
# {Delegates to: DisplayBuffer.getMarkerCount}
getMarkerCount: ->
@buffer.getMarkerCount()

View File

@@ -407,11 +407,11 @@ class TextBuffer
# Returns a {Boolean}.
isEmpty: -> @text.isEmpty()
# Returns all valid {BufferMarker}s on the buffer.
# Returns all valid {StringMarker}s on the buffer.
getMarkers: ->
@text.getMarkers()
# Returns the {BufferMarker} with the given id.
# Returns the {StringMarker} with the given id.
getMarker: (id) ->
@text.getMarker(id)
@@ -431,7 +431,7 @@ class TextBuffer
# startRow - The row at which the marker starts
# endRow - The row at which the marker ends
#
# Returns an {Array} of {BufferMarker}s
# Returns an {Array} of {StringMarker}s
findMarkers: (attributes) ->
@text.findMarkers(attributes)
@@ -458,7 +458,7 @@ class TextBuffer
# Constructs a new marker at a given position.
#
# position - The marker {Point}; there won't be a tail
# options - Options to pass to the {BufferMarker} constructor
# options - Options to pass to the {StringMarker} constructor
#
# Returns a {Number} representing the new marker's ID.
markPosition: (position, options) ->