github/atom
1
1
Fork 0
mirror of https://github.com/atom/atom.git synced 2026-02-01 10:14:58 -05:00
Code Issues Packages Projects Releases Wiki Activity

Drop “experimental” warnings from marker layer APIs

Browse Source
This commit is contained in:
Nathan Sobo
2016-04-08 10:25:25 -06:00
parent 37bfbe8538
commit 5e5cea9600
1 changed files with 6 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
src/text-editor.coffee
View File

@@ -1646,16 +1646,14 @@ class TextEditor extends Model
decorateMarker: (marker, decorationParams) ->
@decorationManager.decorateMarker(marker, decorationParams)
# Essential: *Experimental:* Add a decoration to every marker in the given
# marker layer. Can be used to decorate a large number of markers without
# having to create and manage many individual decorations.
# Essential: Add a decoration to every marker in the given marker layer. Can
# be used to decorate a large number of markers without having to create and
# manage many individual decorations.
#
# * `markerLayer` A {DisplayMarkerLayer} or {MarkerLayer} to decorate.
# * `decorationParams` The same parameters that are passed to
# {decorateMarker}, except the `type` cannot be `overlay` or `gutter`.
#
# This API is experimental and subject to change on any release.
#
# Returns a {LayerDecoration}.
decorateMarkerLayer: (markerLayer, decorationParams) ->
@decorationManager.decorateMarkerLayer(markerLayer, decorationParams)
@@ -1903,7 +1901,7 @@ class TextEditor extends Model
destroyMarker: (id) ->
@getMarker(id)?.destroy()
# Extended: *Experimental:* Create a marker layer to group related markers.
# Essential: Create a marker layer to group related markers.
#
# * `options` An {Object} containing the following keys:
# * `maintainHistory` A {Boolean} indicating whether marker state should be
@@ -1914,30 +1912,24 @@ class TextEditor extends Model
# maintained across the serialization boundary, allowing you to retrieve
# it via {::getMarkerLayer}.
#
# This API is experimental and subject to change on any release.
#
# Returns a {DisplayMarkerLayer}.
addMarkerLayer: (options) ->
@displayLayer.addMarkerLayer(options)
# Public: *Experimental:* Get a {DisplayMarkerLayer} by id.
# Essential: Get a {DisplayMarkerLayer} by id.
#
# * `id` The id of the marker layer to retrieve.
#
# This API is experimental and subject to change on any release.
#
# Returns a {DisplayMarkerLayer} or `undefined` if no layer exists with the
# given id.
getMarkerLayer: (id) ->
@displayLayer.getMarkerLayer(id)
# Public: *Experimental:* Get the default {DisplayMarkerLayer}.
# Essential: Get the default {DisplayMarkerLayer}.
#
# All marker APIs not tied to an explicit layer interact with this default
# layer.
#
# This API is experimental and subject to change on any release.
#
# Returns a {DisplayMarkerLayer}.
getDefaultMarkerLayer: ->
@defaultMarkerLayer