diff --git a/src/clipboard.coffee b/src/clipboard.coffee index 00725b5e7..4a7a8eb23 100644 --- a/src/clipboard.coffee +++ b/src/clipboard.coffee @@ -3,7 +3,7 @@ crypto = require 'crypto' # Public: Represents the clipboard used for copying and pasting in Atom. # -# A clipboard instance is always available under the `atom.clipboard` global. +# An instance of this class is always available as the `atom.clipboard` global. module.exports = class Clipboard metadata: null diff --git a/src/config.coffee b/src/config.coffee index 68a7b464f..e4449c899 100644 --- a/src/config.coffee +++ b/src/config.coffee @@ -8,8 +8,7 @@ pathWatcher = require 'pathwatcher' # Public: Used to access all of Atom's configuration details. # -# A global instance of this class is available to all plugins which can be -# referenced using `atom.config` +# An instance of this class is always available as the `atom.config` global. # # ### Best practices # diff --git a/src/context-menu-manager.coffee b/src/context-menu-manager.coffee index 2cbfe0364..2236a1ca0 100644 --- a/src/context-menu-manager.coffee +++ b/src/context-menu-manager.coffee @@ -5,7 +5,8 @@ remote = require 'remote' # Public: Provides a registry for commands that you'd like to appear in the # context menu. # -# Should be accessed via `atom.contextMenu`. +# An instance of this class is always available as the `atom.contextMenu` +# global. module.exports = class ContextMenuManager # Private: diff --git a/src/menu-manager.coffee b/src/menu-manager.coffee index 00bcb86e6..2f7ded8e0 100644 --- a/src/menu-manager.coffee +++ b/src/menu-manager.coffee @@ -8,7 +8,7 @@ fs = require 'fs-plus' # Public: Provides a registry for menu items that you'd like to appear in the # application menu. # -# Should be accessed via `atom.menu`. +# An instance of this class is always available as the `atom.menu` global. module.exports = class MenuManager pendingUpdateOperation: null diff --git a/src/package-manager.coffee b/src/package-manager.coffee index e94a69785..85b598009 100644 --- a/src/package-manager.coffee +++ b/src/package-manager.coffee @@ -6,6 +6,8 @@ path = require 'path' # Public: Package manager for coordinating the lifecycle of Atom packages. # +# An instance of this class is always available as the `atom.packages` global. +# # Packages can be loaded, activated, and deactivated, and unloaded: # * Loading a package reads and parses the package's metadata and resources # such as keymaps, menus, stylesheets, etc. @@ -17,8 +19,6 @@ path = require 'path' # # Packages can also be enabled/disabled via the `core.disabledPackages` config # settings and also by calling `enablePackage()/disablePackage()`. -# -# An instance of this class is globally available via `atom.packages`. module.exports = class PackageManager Emitter.includeInto(this) diff --git a/src/project.coffee b/src/project.coffee index 62f5f0dbe..510e41cb2 100644 --- a/src/project.coffee +++ b/src/project.coffee @@ -16,7 +16,7 @@ Git = require './git' # Public: Represents a project that's opened in Atom. # -# There is always a project available under the `atom.project` global. +# An instance of this class is always available as the `atom.project` global. module.exports = class Project extends Model atom.deserializers.add(this) diff --git a/src/syntax.coffee b/src/syntax.coffee index af1a6278a..13e12e609 100644 --- a/src/syntax.coffee +++ b/src/syntax.coffee @@ -8,10 +8,10 @@ Token = require './token' # Public: Syntax class holding the grammars used for tokenizing. # +# An instance of this class is always available as the `atom.syntax` global. +# # The Syntax class also contains properties for things such as the # language-specific comment regexes. -# -# There is always a syntax object available under the `atom.syntax` global. module.exports = class Syntax extends GrammarRegistry Subscriber.includeInto(this) diff --git a/src/theme-manager.coffee b/src/theme-manager.coffee index b26d366bf..b6eb0c590 100644 --- a/src/theme-manager.coffee +++ b/src/theme-manager.coffee @@ -10,7 +10,7 @@ File = require './file' # Public: Handles loading and activating available themes. # -# A ThemeManager instance is always available under the `atom.themes` global. +# An instance of this class is always available as the `atom.themes` global. module.exports = class ThemeManager Emitter.includeInto(this) diff --git a/src/workspace-view.coffee b/src/workspace-view.coffee index 908f25a9d..e1e5ef34b 100644 --- a/src/workspace-view.coffee +++ b/src/workspace-view.coffee @@ -16,6 +16,9 @@ Editor = require './editor' # Public: The container for the entire Atom application. # +# An instance of this class is always available as the `atom.workspaceView` +# global. +# # ## Commands # # * `application:about` - Opens the about dialog. diff --git a/src/workspace.coffee b/src/workspace.coffee index 21663bb59..68ce0f7f2 100644 --- a/src/workspace.coffee +++ b/src/workspace.coffee @@ -7,8 +7,9 @@ PaneContainer = require './pane-container' Pane = require './pane' # Public: Represents the view state of the entire window, including the panes at -# the center and panels around the periphery. You can access the singleton -# instance via `atom.workspace`. +# the center and panels around the periphery. +# +# An instance of this class is always available as the `atom.workspace` global. module.exports = class Workspace extends Model atom.deserializers.add(this)