Migrate to block comments

atom/browser/api/lib/app.coffee

@@ -34,13 +34,13 @@ app.setAppPath = (path) ->
 app.getAppPath = ->
   appPath
 
-# Routes the events to webContents.
+### Routes the events to webContents. ###
 for name in ['login', 'certificate-error', 'select-client-certificate']
   do (name) ->
     app.on name, (event, webContents, args...) ->
       webContents.emit name, event, args...
 
-# Deprecated.
+### Deprecated. ###
 app.getHomeDir = deprecate 'app.getHomeDir', 'app.getPath', ->
   @getPath 'home'
 app.getDataPath = deprecate 'app.getDataPath', 'app.getPath', ->
@@ -51,22 +51,23 @@ app.resolveProxy = deprecate 'app.resolveProxy', 'session.defaultSession.resolve
   session.defaultSession.resolveProxy url, callback
 deprecate.rename app, 'terminate', 'quit'
 deprecate.event app, 'finish-launching', 'ready', ->
-  setImmediate => # give default app a chance to setup default menu.
+  ### give default app a chance to setup default menu. ###
+  setImmediate =>
     @emit 'finish-launching'
 deprecate.event app, 'activate-with-no-open-windows', 'activate', (event, hasVisibleWindows) ->
   @emit 'activate-with-no-open-windows', event if not hasVisibleWindows
 deprecate.event app, 'select-certificate', 'select-client-certificate'
 
-# Wrappers for native classes.
+### Wrappers for native classes. ###
 wrapDownloadItem = (downloadItem) ->
-  # downloadItem is an EventEmitter.
+  ### downloadItem is an EventEmitter. ###
   downloadItem.__proto__ = EventEmitter.prototype
-  # Deprecated.
+  ### Deprecated. ###
   deprecate.property downloadItem, 'url', 'getURL'
   deprecate.property downloadItem, 'filename', 'getFilename'
   deprecate.property downloadItem, 'mimeType', 'getMimeType'
   deprecate.rename downloadItem, 'getUrl', 'getURL'
 downloadItemBindings._setWrapDownloadItem wrapDownloadItem
 
-# Only one App object pemitted.
+### Only one App object pemitted. ###
 module.exports = app

atom/browser/api/lib/auto-updater.coffee

@@ -6,7 +6,7 @@ autoUpdater =
   else
     require './auto-updater/auto-updater-native'
 
-# Deprecated.
+### Deprecated. ###
 deprecate.rename autoUpdater, 'setFeedUrl', 'setFeedURL'
 
 module.exports = autoUpdater

atom/browser/api/lib/auto-updater/auto-updater-win.coffee

@@ -28,14 +28,16 @@ class AutoUpdater extends EventEmitter
         return @emitError error if error?
 
         {releaseNotes, version} = update
-        # Following information is not available on Windows, so fake them.
+        ### Following information is not available on Windows, so fake them. ###
         date = new Date
         url = @updateURL
 
         @emit 'update-downloaded', {}, releaseNotes, version, date, url, => @quitAndInstall()
 
-  # Private: Emit both error object and message, this is to keep compatibility
-  # with Old APIs.
+  ###
+    Private: Emit both error object and message, this is to keep compatibility
+    with Old APIs.
+  ###
   emitError: (message) ->
     @emit 'error', new Error(message), message
 

atom/browser/api/lib/auto-updater/squirrel-update-win.coffee

@@ -2,17 +2,21 @@ fs      = require 'fs'
 path    = require 'path'
 {spawn} = require 'child_process'
 
-appFolder = path.dirname process.execPath # i.e. my-app/app-0.1.13/
-updateExe = path.resolve appFolder, '..', 'Update.exe' # i.e. my-app/Update.exe
+### i.e. my-app/app-0.1.13/ ###
+appFolder = path.dirname process.execPath
+### i.e. my-app/Update.exe ###
+updateExe = path.resolve appFolder, '..', 'Update.exe'
 exeName   = path.basename process.execPath
 
-# Spawn a command and invoke the callback when it completes with an error
-# and the output from standard out.
+###
+  Spawn a command and invoke the callback when it completes with an error
+  and the output from standard out.
+###
 spawnUpdate = (args, detached, callback) ->
   try
     spawnedProcess = spawn updateExe, args, {detached}
   catch error
-    # Shouldn't happen, but still guard it.
+    ### Shouldn't happen, but still guard it. ###
     process.nextTick -> callback error
     return
 
@@ -26,27 +30,27 @@ spawnUpdate = (args, detached, callback) ->
     errorEmitted = true
     callback error
   spawnedProcess.on 'exit', (code, signal) ->
-    # We may have already emitted an error.
+    ### We may have already emitted an error. ###
     return if errorEmitted
 
-    # Process terminated with error.
+    ### Process terminated with error. ###
     if code isnt 0
       return callback "Command failed: #{signal ? code}\n#{stderr}"
 
-    # Success.
+    ### Success. ###
     callback null, stdout
 
-# Start an instance of the installed app.
+### Start an instance of the installed app. ###
 exports.processStart = (callback) ->
   spawnUpdate ['--processStart', exeName], true, ->
 
-# Download the releases specified by the URL and write new results to stdout.
+### Download the releases specified by the URL and write new results to stdout. ###
 exports.download = (updateURL, callback) ->
   spawnUpdate ['--download', updateURL], false, (error, stdout) ->
     return callback(error) if error?
 
     try
-      # Last line of output is the JSON details about the releases
+      ### Last line of output is the JSON details about the releases ###
       json = stdout.trim().split('\n').pop()
       update = JSON.parse(json)?.releasesToApply?.pop?()
     catch
@@ -54,11 +58,11 @@ exports.download = (updateURL, callback) ->
 
     callback null, update
 
-# Update the application to the latest remote version specified by URL.
+### Update the application to the latest remote version specified by URL. ###
 exports.update = (updateURL, callback) ->
   spawnUpdate ['--update', updateURL], false, callback
 
-# Is the Update.exe installed with the current application?
+### Is the Update.exe installed with the current application? ###
 exports.supported = ->
   try
     fs.accessSync updateExe, fs.R_OK

atom/browser/api/lib/browser-window.coffee

@@ -5,56 +5,61 @@
 BrowserWindow::__proto__ = EventEmitter.prototype
 
 BrowserWindow::_init = ->
-  {app} = require 'electron'  # avoid recursive require.
+  ### avoid recursive require. ###
+  {app} = require 'electron'
 
-  # Simulate the application menu on platforms other than OS X.
+  ### Simulate the application menu on platforms other than OS X. ###
   if process.platform isnt 'darwin'
     menu = app.getApplicationMenu()
     @setMenu menu if menu?
 
-  # Make new windows requested by links behave like "window.open"
+  ### Make new windows requested by links behave like "window.open" ###
   @webContents.on '-new-window', (event, url, frameName) ->
     options = show: true, width: 800, height: 600
     ipcMain.emit 'ATOM_SHELL_GUEST_WINDOW_MANAGER_WINDOW_OPEN', event, url, frameName, options
 
-  # window.resizeTo(...)
-  # window.moveTo(...)
+  ###
+    window.resizeTo(...)
+    window.moveTo(...)
+  ###
   @webContents.on 'move', (event, size) =>
     @setBounds size
 
-  # Hide the auto-hide menu when webContents is focused.
+  ### Hide the auto-hide menu when webContents is focused. ###
   @webContents.on 'activate', =>
     if process.platform isnt 'darwin' and @isMenuBarAutoHide() and @isMenuBarVisible()
       @setMenuBarVisibility false
 
-  # Forward the crashed event.
+  ### Forward the crashed event. ###
   @webContents.on 'crashed', =>
     @emit 'crashed'
 
-  # Change window title to page title.
+  ### Change window title to page title. ###
   @webContents.on 'page-title-updated', (event, title, explicitSet) =>
     @emit 'page-title-updated', event, title
     @setTitle title unless event.defaultPrevented
 
-  # Sometimes the webContents doesn't get focus when window is shown, so we have
-  # to force focusing on webContents in this case. The safest way is to focus it
-  # when we first start to load URL, if we do it earlier it won't have effect,
-  # if we do it later we might move focus in the page.
-  # Though this hack is only needed on OS X when the app is launched from
-  # Finder, we still do it on all platforms in case of other bugs we don't know.
+  ###
+    Sometimes the webContents doesn't get focus when window is shown, so we have
+    to force focusing on webContents in this case. The safest way is to focus it
+    when we first start to load URL, if we do it earlier it won't have effect,
+    if we do it later we might move focus in the page.
+    Though this hack is only needed on OS X when the app is launched from
+    Finder, we still do it on all platforms in case of other bugs we don't know.
+  ###
   @webContents.once 'load-url', ->
     @focus()
 
-  # Redirect focus/blur event to app instance too.
+  ### Redirect focus/blur event to app instance too. ###
   @on 'blur', (event) =>
     app.emit 'browser-window-blur', event, this
   @on 'focus', (event) =>
     app.emit 'browser-window-focus', event, this
 
-  # Notify the creation of the window.
+  ### Notify the creation of the window. ###
   app.emit 'browser-window-created', {}, this
 
-  # Be compatible with old APIs.
+  ### Be compatible with old APIs. ###
   @webContents.on 'devtools-focused', => @emit 'devtools-focused'
   @webContents.on 'devtools-opened', => @emit 'devtools-opened'
   @webContents.on 'devtools-closed', => @emit 'devtools-closed'
@@ -76,7 +81,7 @@ BrowserWindow.fromDevToolsWebContents = (webContents) ->
   windows = BrowserWindow.getAllWindows()
   return window for window in windows when window.devToolsWebContents?.equal webContents
 
-# Helpers.
+### Helpers. ###
 BrowserWindow::loadURL = -> @webContents.loadURL.apply @webContents, arguments
 BrowserWindow::getURL = -> @webContents.getURL()
 BrowserWindow::reload = -> @webContents.reload.apply @webContents, arguments
@@ -89,7 +94,7 @@ BrowserWindow::toggleDevTools = -> @webContents.toggleDevTools()
 BrowserWindow::inspectElement = -> @webContents.inspectElement.apply @webContents, arguments
 BrowserWindow::inspectServiceWorker = -> @webContents.inspectServiceWorker()
 
-# Deprecated.
+### Deprecated. ###
 deprecate.member BrowserWindow, 'undo', 'webContents'
 deprecate.member BrowserWindow, 'redo', 'webContents'
 deprecate.member BrowserWindow, 'cut', 'webContents'

atom/browser/api/lib/dialog.coffee

@@ -16,12 +16,12 @@ messageBoxOptions =
 
 parseArgs = (window, options, callback) ->
   unless window is null or window?.constructor is BrowserWindow
-    # Shift.
+    ### Shift. ###
     callback = options
     options = window
     window = null
   if not callback? and typeof options is 'function'
-    # Shift.
+    ### Shift. ###
     callback = options
     options = null
   [window, options, callback]
@@ -97,7 +97,7 @@ module.exports =
     options.icon ?= null
     options.defaultId ?= -1
 
-    # Choose a default button to get selected when dialog is cancelled.
+    ### Choose a default button to get selected when dialog is cancelled. ###
     unless options.cancelId?
       options.cancelId = 0
       for text, i in options.buttons
@@ -122,6 +122,6 @@ module.exports =
   showErrorBox: (args...) ->
     binding.showErrorBox args...
 
-# Mark standard asynchronous functions.
+### Mark standard asynchronous functions. ###
 for api in ['showMessageBox', 'showOpenDialog', 'showSaveDialog']
   v8Util.setHiddenValue module.exports[api], 'asynchronous', true

atom/browser/api/lib/exports/electron.coffee

@@ -1,10 +1,10 @@
 common = require '../../../../common/api/lib/exports/electron'
 
-# Import common modules.
+### Import common modules. ###
 common.defineProperties exports
 
 Object.defineProperties exports,
-  # Browser side modules, please sort with alphabet order.
+  ### Browser side modules, please sort with alphabet order. ###
   app:
     enumerable: true
     get: -> require '../app'
@@ -50,7 +50,7 @@ Object.defineProperties exports,
   Tray:
     enumerable: true
     get: -> require '../tray'
-  # The internal modules, invisible unless you know their names.
+  ### The internal modules, invisible unless you know their names. ###
   NavigationController:
     get: -> require '../navigation-controller'
   webContents:

atom/browser/api/lib/ipc.coffee

@@ -1,6 +1,6 @@
 {deprecate, ipcMain} = require 'electron'
 
-# This module is deprecated, we mirror everything from ipcMain.
+### This module is deprecated, we mirror everything from ipcMain. ###
 deprecate.warn 'ipc module', 'require("electron").ipcMain'
 
 module.exports = ipcMain

atom/browser/api/lib/menu-item.coffee

@@ -2,7 +2,7 @@ v8Util = process.atomBinding 'v8_util'
 
 nextCommandId = 0
 
-# Maps role to methods of webContents
+### Maps role to methods of webContents ###
 rolesMap =
   undo: 'undo'
   redo: 'redo'
@@ -13,7 +13,7 @@ rolesMap =
   minimize: 'minimize'
   close: 'close'
 
-# Maps methods that should be called directly on the BrowserWindow instance
+### Maps methods that should be called directly on the BrowserWindow instance ###
 methodInBrowserWindow =
   minimize: true
   close: true
@@ -46,7 +46,7 @@ class MenuItem
 
     @commandId = ++nextCommandId
     @click = (focusedWindow) =>
-      # Manually flip the checked flags when clicked.
+      ### Manually flip the checked flags when clicked. ###
       @checked = !@checked if @type in ['checkbox', 'radio']
 
       if @role and rolesMap[@role] and process.platform isnt 'darwin' and focusedWindow?

atom/browser/api/lib/menu.coffee

@@ -4,11 +4,11 @@
 v8Util = process.atomBinding 'v8_util'
 bindings = process.atomBinding 'menu'
 
-# Automatically generated radio menu item's group id.
+### Automatically generated radio menu item's group id. ###
 nextGroupId = 0
 
-# Search between seperators to find a radio menu item and return its group id,
-# otherwise generate a group id.
+### Search between seperators to find a radio menu item and return its group id, ###
+### otherwise generate a group id. ###
 generateGroupId = (items, pos) ->
   if pos > 0
     for i in [pos - 1..0]
@@ -22,12 +22,12 @@ generateGroupId = (items, pos) ->
       break if item.type is 'separator'
   ++nextGroupId
 
-# Returns the index of item according to |id|.
+### Returns the index of item according to |id|. ###
 indexOfItemById = (items, id) ->
   return i for item, i in items when item.id is id
   -1
 
-# Returns the index of where to insert the item according to |position|.
+### Returns the index of where to insert the item according to |position|. ###
 indexToInsertByPosition = (items, position) ->
   return items.length unless position
 
@@ -41,12 +41,12 @@ indexToInsertByPosition = (items, position) ->
     when 'after'
       insertIndex++
     when 'endof'
-      # If the |id| doesn't exist, then create a new group with the |id|.
+      ### If the |id| doesn't exist, then create a new group with the |id|. ###
       if insertIndex is -1
         items.push id: id, type: 'separator'
         insertIndex = items.length - 1
 
-      # Find the end of the group.
+      ### Find the end of the group. ###
       insertIndex++
       while insertIndex < items.length and items[insertIndex].type isnt 'separator'
         insertIndex++
@@ -69,7 +69,7 @@ Menu::_init = ->
     executeCommand: (commandId) =>
       @commandsMap[commandId]?.click BrowserWindow.getFocusedWindow()
     menuWillShow: =>
-      # Make sure radio groups have at least one menu item seleted.
+      ### Make sure radio groups have at least one menu item seleted. ###
       for id, group of @groupsMap
         checked = false
         for radioItem in group when radioItem.checked
@@ -79,7 +79,7 @@ Menu::_init = ->
 
 Menu::popup = (window, x, y) ->
   unless window?.constructor is BrowserWindow
-    # Shift.
+    ### Shift. ###
     y = x
     x = window
     window = BrowserWindow.getFocusedWindow()
@@ -100,12 +100,12 @@ Menu::insert = (pos, item) ->
     when 'separator' then @insertSeparator pos
     when 'submenu' then @insertSubMenu pos, item.commandId, item.label, item.submenu
     when 'radio'
-      # Grouping radio menu items.
+      ### Grouping radio menu items. ###
       item.overrideReadOnlyProperty 'groupId', generateGroupId(@items, pos)
       @groupsMap[item.groupId] ?= []
       @groupsMap[item.groupId].push item
 
-      # Setting a radio menu item should flip other items in the group.
+      ### Setting a radio menu item should flip other items in the group. ###
       v8Util.setHiddenValue item, 'checked', item.checked
       Object.defineProperty item, 'checked',
         enumerable: true
@@ -121,14 +121,14 @@ Menu::insert = (pos, item) ->
   @setIcon pos, item.icon if item.icon?
   @setRole pos, item.role if item.role?
 
-  # Make menu accessable to items.
+  ### Make menu accessable to items. ###
   item.overrideReadOnlyProperty 'menu', this
 
-  # Remember the items.
+  ### Remember the items. ###
   @items.splice pos, 0, item
   @commandsMap[item.commandId] = item
 
-# Force menuWillShow to be called
+### Force menuWillShow to be called ###
 Menu::_callMenuWillShow = ->
   @delegate?.menuWillShow()
   item.submenu._callMenuWillShow() for item in @items when item.submenu?
@@ -136,7 +136,8 @@ Menu::_callMenuWillShow = ->
 applicationMenu = null
 Menu.setApplicationMenu = (menu) ->
   throw new TypeError('Invalid menu') unless menu is null or menu.constructor is Menu
-  applicationMenu = menu  # Keep a reference.
+  ### Keep a reference. ###
+  applicationMenu = menu
 
   if process.platform is 'darwin'
     return if menu is null
@@ -160,7 +161,7 @@ Menu.buildFromTemplate = (template) ->
     if item.position
       insertIndex = indexToInsertByPosition positionedTemplate, item.position
     else
-      # If no |position| is specified, insert after last item.
+      ### If no |position| is specified, insert after last item. ###
       insertIndex++
     positionedTemplate.splice insertIndex, 0, item
 

atom/browser/api/lib/navigation-controller.coffee

@@ -1,42 +1,47 @@
 {ipcMain} = require 'electron'
 
-# The history operation in renderer is redirected to browser.
+### The history operation in renderer is redirected to browser. ###
 ipcMain.on 'ATOM_SHELL_NAVIGATION_CONTROLLER', (event, method, args...) ->
   event.sender[method] args...
 
 ipcMain.on 'ATOM_SHELL_SYNC_NAVIGATION_CONTROLLER', (event, method, args...) ->
   event.returnValue = event.sender[method] args...
 
-# JavaScript implementation of Chromium's NavigationController.
-# Instead of relying on Chromium for history control, we compeletely do history
-# control on user land, and only rely on WebContents.loadURL for navigation.
-# This helps us avoid Chromium's various optimizations so we can ensure renderer
-# process is restarted everytime.
+###
+  JavaScript implementation of Chromium's NavigationController.
+  Instead of relying on Chromium for history control, we compeletely do history
+  control on user land, and only rely on WebContents.loadURL for navigation.
+  This helps us avoid Chromium's various optimizations so we can ensure renderer
+  process is restarted everytime.
+###
 class NavigationController
   constructor: (@webContents) ->
     @clearHistory()
 
-    # webContents may have already navigated to a page.
+    ### webContents may have already navigated to a page. ###
     if @webContents._getURL()
       @currentIndex++
       @history.push @webContents._getURL()
 
     @webContents.on 'navigation-entry-commited', (event, url, inPage, replaceEntry) =>
       if @inPageIndex > -1 and not inPage
-        # Navigated to a new page, clear in-page mark.
+        ### Navigated to a new page, clear in-page mark. ###
         @inPageIndex = -1
       else if @inPageIndex is -1 and inPage
-        # Started in-page navigations.
+        ### Started in-page navigations. ###
         @inPageIndex = @currentIndex
 
-      if @pendingIndex >= 0 # Go to index.
+      if @pendingIndex >= 0
+        ### Go to index. ###
         @currentIndex = @pendingIndex
         @pendingIndex = -1
         @history[@currentIndex] = url
-      else if replaceEntry # Non-user initialized navigation.
+      else if replaceEntry
+        ### Non-user initialized navigation. ###
         @history[@currentIndex] = url
-      else  # Normal navigation.
-        @history = @history.slice 0, @currentIndex + 1  # Clear history.
+      else
+        ### Normal navigation. Clear history. ###
+        @history = @history.slice 0, @currentIndex + 1
         currentEntry = @history[@currentIndex]
         if currentEntry?.url isnt url
           @currentIndex++

atom/browser/api/lib/protocol.coffee

@@ -4,7 +4,7 @@ throw new Error('Can not initialize protocol module before app is ready') unless
 
 {protocol} = process.atomBinding 'protocol'
 
-# Warn about removed APIs.
+### Warn about removed APIs. ###
 logAndThrow = (callback, message) ->
   console.error message
   if callback then callback(new Error(message)) else throw new Error(message)

atom/browser/api/lib/session.coffee

@@ -4,7 +4,7 @@ bindings = process.atomBinding 'session'
 
 PERSIST_PERFIX = 'persist:'
 
-# Returns the Session from |partition| string.
+### Returns the Session from |partition| string. ###
 exports.fromPartition = (partition='') ->
   return exports.defaultSession if partition is ''
   if partition.startsWith PERSIST_PERFIX
@@ -12,13 +12,13 @@ exports.fromPartition = (partition='') ->
   else
     bindings.fromPartition partition, true
 
-# Returns the default session.
+### Returns the default session. ###
 Object.defineProperty exports, 'defaultSession',
   enumerable: true
   get: -> bindings.fromPartition '', false
 
 wrapSession = (session) ->
-  # session is an EventEmitter.
+  ### session is an EventEmitter. ###
   session.__proto__ = EventEmitter.prototype
 
 bindings._setWrapSession wrapSession

atom/browser/api/lib/tray.coffee

@@ -5,7 +5,7 @@
 Tray::__proto__ = EventEmitter.prototype
 
 Tray::_init = ->
-  # Deprecated.
+  ### Deprecated. ###
   deprecate.rename this, 'popContextMenu', 'popUpContextMenu'
   deprecate.event this, 'clicked', 'click'
   deprecate.event this, 'double-clicked', 'double-click'
@@ -14,6 +14,7 @@ Tray::_init = ->
 
 Tray::setContextMenu = (menu) ->
   @_setContextMenu menu
-  @menu = menu  # Keep a strong reference of menu.
+  ### Keep a strong reference of menu. ###
+  @menu = menu
 
 module.exports = Tray

atom/browser/api/lib/web-contents.coffee

@@ -40,28 +40,30 @@ PDFPageSize =
     custom_display_name: "Tabloid"
 
 wrapWebContents = (webContents) ->
-  # webContents is an EventEmitter.
+  ### webContents is an EventEmitter. ###
   webContents.__proto__ = EventEmitter.prototype
 
-  # WebContents::send(channel, args..)
+  ### WebContents::send(channel, args..) ###
   webContents.send = (channel, args...) ->
     @_send channel, [args...]
 
-  # Make sure webContents.executeJavaScript would run the code only when the
-  # web contents has been loaded.
+  ###
+    Make sure webContents.executeJavaScript would run the code only when the
+    web contents has been loaded.
+  ###
   webContents.executeJavaScript = (code, hasUserGesture=false) ->
     if @getURL() and not @isLoading()
       @_executeJavaScript code, hasUserGesture
     else
       webContents.once 'did-finish-load', @_executeJavaScript.bind(this, code, hasUserGesture)
 
-  # The navigation controller.
+  ### The navigation controller. ###
   controller = new NavigationController(webContents)
   for name, method of NavigationController.prototype when method instanceof Function
     do (name, method) ->
       webContents[name] = -> method.apply controller, arguments
 
-  # Dispatch IPC messages to the ipc module.
+  ### Dispatch IPC messages to the ipc module. ###
   webContents.on 'ipc-message', (event, packed) ->
     [channel, args...] = packed
     ipcMain.emit channel, event, args...
@@ -70,22 +72,24 @@ wrapWebContents = (webContents) ->
     Object.defineProperty event, 'returnValue', set: (value) -> event.sendReply JSON.stringify(value)
     ipcMain.emit channel, event, args...
 
-  # Handle context menu action request from pepper plugin.
+  ### Handle context menu action request from pepper plugin. ###
   webContents.on 'pepper-context-menu', (event, params) ->
     menu = Menu.buildFromTemplate params.menu
     menu.popup params.x, params.y
 
-  # This error occurs when host could not be found.
+  ### This error occurs when host could not be found. ###
   webContents.on 'did-fail-provisional-load', (args...) ->
-    # Calling loadURL during this event might cause crash, so delay the event
-    # until next tick.
+    ###
+      Calling loadURL during this event might cause crash, so delay the event
+      until next tick.
+    ###
     setImmediate => @emit 'did-fail-load', args...
 
-  # Delays the page-title-updated event to next tick.
+  ### Delays the page-title-updated event to next tick. ###
   webContents.on '-page-title-updated', (args...) ->
     setImmediate => @emit 'page-title-updated', args...
 
-  # Deprecated.
+  ### Deprecated. ###
   deprecate.rename webContents, 'loadUrl', 'loadURL'
   deprecate.rename webContents, 'getUrl', 'getURL'
   deprecate.event webContents, 'page-title-set', 'page-title-updated', (args...) ->