diff --git a/src/workspace-view.coffee b/src/workspace-view.coffee index 3703d04b0..9da0d7b90 100644 --- a/src/workspace-view.coffee +++ b/src/workspace-view.coffee @@ -15,7 +15,7 @@ PaneRowView = require './pane-row-view' PaneContainerView = require './pane-container-view' Editor = require './editor' -# Public: The top-level view for the entire window. An instance of this class is +# Essential: The top-level view for the entire window. An instance of this class is # available via the `atom.workspaceView` global. # # It is backed by a model object, an instance of {Workspace}, which is available @@ -44,7 +44,7 @@ Editor = require './editor' # the built-in `atom` module. # # ```coffee -# {WorkspaceView} = require 'atom' +# {WorkspaceView} = require 'atom' # ``` # # You can assign it to the `atom.workspaceView` global in the spec or just use @@ -244,40 +244,56 @@ class WorkspaceView extends View # Public: Prepend an element or view to the panels at the top of the # workspace. + # + # * `element` jQuery object or DOM element prependToTop: (element) -> @vertical.prepend(element) # Public: Append an element or view to the panels at the top of the workspace. + # + # * `element` jQuery object or DOM element appendToTop: (element) -> @panes.before(element) # Public: Prepend an element or view to the panels at the bottom of the # workspace. + # + # * `element` jQuery object or DOM element prependToBottom: (element) -> @panes.after(element) # Public: Append an element or view to the panels at the bottom of the # workspace. + # + # * `element` jQuery object or DOM element appendToBottom: (element) -> @vertical.append(element) # Public: Prepend an element or view to the panels at the left of the # workspace. + # + # * `element` jQuery object or DOM element prependToLeft: (element) -> @horizontal.prepend(element) # Public: Append an element or view to the panels at the left of the # workspace. + # + # * `element` jQuery object or DOM element appendToLeft: (element) -> @vertical.before(element) # Public: Prepend an element or view to the panels at the right of the # workspace. + # + # * `element` jQuery object or DOM element prependToRight: (element) -> @vertical.after(element) # Public: Append an element or view to the panels at the right of the # workspace. + # + # * `element` jQuery object or DOM element appendToRight: (element) -> @horizontal.append(element) @@ -317,7 +333,8 @@ class WorkspaceView extends View # Public: Register a function to be called for every current and future # pane view in the workspace. # - # callback - A {Function} with a {PaneView} as its only argument. + # * `callback` A {Function} with a {PaneView} as its only argument. + # * `paneView` {PaneView} # # Returns a subscription object with an `.off` method that you can call to # unregister the callback. @@ -338,7 +355,8 @@ class WorkspaceView extends View # editor view in the workspace (only includes {EditorView}s that are pane # items). # - # callback - A {Function} with an {EditorView} as its only argument. + # * `callback` A {Function} with an {EditorView} as its only argument. + # * `editorView` {EditorView} # # Returns a subscription object with an `.off` method that you can call to # unregister the callback.