From fbb3bc42326ace82ac4b8e7ec6cef15bc13e33d1 Mon Sep 17 00:00:00 2001 From: Maxim Sokolov Date: Wed, 26 Aug 2015 11:44:31 +0300 Subject: [PATCH] :memo: Make Gutter class extended Gutter is returned from a public method `TextEditor::addGutter` --- src/gutter.coffee | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/src/gutter.coffee b/src/gutter.coffee index 0b3b6533b..d3ea16c95 100644 --- a/src/gutter.coffee +++ b/src/gutter.coffee @@ -1,19 +1,14 @@ {Emitter} = require 'event-kit' -# Public: This class represents a gutter within a TextEditor. - DefaultPriority = -100 +# Extended: Represents a gutter within a {TextEditor}. +# +# ### Gutter Creation +# +# See {TextEditor::addGutter} for usage. module.exports = class Gutter - # * `gutterContainer` The {GutterContainer} object to which this gutter belongs. - # * `options` An {Object} with the following fields: - # * `name` (required) A unique {String} to identify this gutter. - # * `priority` (optional) A {Number} that determines stacking order between - # gutters. Lower priority items are forced closer to the edges of the - # window. (default: -100) - # * `visible` (optional) {Boolean} specifying whether the gutter is visible - # initially after being created. (default: true) constructor: (gutterContainer, options) -> @gutterContainer = gutterContainer @name = options?.name