github/atom
1
1
Fork 0
mirror of https://github.com/atom/atom.git synced 2026-04-28 03:01:47 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #8122 from ssorallen/atom-properties-ret-values

Browse Source 
Use `Returns` keyword in global `atom` object docs
This commit is contained in:
Kevin Sawicki
2015-07-28 17:33:28 -07:00
parent 69bf55ce29 51c73bd6e9
commit a81e59c79b
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/atom.coffee
View File

@@ -368,15 +368,15 @@ class Atom extends Model
Section: Atom Details
###
# Public: Is the current window in development mode?
# Public: Returns a {Boolean} that is `true` if the current window is in development mode.
inDevMode: ->
@devMode ?= @getLoadSettings().devMode
# Public: Is the current window in safe mode?
# Public: Returns a {Boolean} that is `true` if the current window is in safe mode.
inSafeMode: ->
@safeMode ?= @getLoadSettings().safeMode
# Public: Is the current window running specs?
# Public: Returns a {Boolean} that is `true` if the current window is running specs.
inSpecMode: ->
@specMode ?= @getLoadSettings().isSpec
@@ -386,7 +386,7 @@ class Atom extends Model
getVersion: ->
@appVersion ?= @getLoadSettings().appVersion
# Public: Determine whether the current version is an official release.
# Public: Returns a {Boolean} that is `true` if the current version is an official release.
isReleasedVersion: ->
not /\w{7}/.test(@getVersion()) # Check if the release is a 7-character SHA prefix
@@ -502,7 +502,7 @@ class Atom extends Model
reload: ->
ipc.send('call-window-method', 'restart')
# Extended: Returns a {Boolean} true when the current window is maximized.
# Extended: Returns a {Boolean} that is `true` if the current window is maximized.
isMaximized: ->
@getCurrentWindow().isMaximized()
@@ -513,7 +513,7 @@ class Atom extends Model
maximize: ->
ipc.send('call-window-method', 'maximize')
# Extended: Is the current window in full screen mode?
# Extended: Returns a {Boolean} that is `true` if the current window is in full screen mode.
isFullScreen: ->
@getCurrentWindow().isFullScreen()