📝 Update docs for Gutter events

This commit is contained in:
Maxim Sokolov
2015-08-26 10:46:17 +03:00
parent bb447099c0
commit a5edd69ec3

View File

@@ -25,16 +25,20 @@ class Gutter
@emitter.emit 'did-destroy'
@emitter.dispose()
# Calls your `callback` when the {Gutter}'s' visibility changes.
###
Section: Event Subscription
###
# Public: Calls your `callback` when the gutter's visibility changes.
#
# * `callback` {Function}
# * `gutter` The {Gutter} whose visibility changed.
# * `gutter` The gutter whose visibility changed.
#
# Returns a {Disposable} on which `.dispose()` can be called to unsubscribe.
onDidChangeVisible: (callback) ->
@emitter.on 'did-change-visible', callback
# Calls your `callback` when the {Gutter} is destroyed
# Public: Calls your `callback` when the gutter is destroyed.
#
# * `callback` {Function}
#