Migrate to block comments

atom/renderer/api/lib/desktop-capturer.coffee

@@ -3,7 +3,7 @@
 nextId = 0
 getNextId = -> ++nextId
 
-# |options.type| can not be empty and has to include 'window' or 'screen'.
+### |options.type| can not be empty and has to include 'window' or 'screen'. ###
 isValid = (options) ->
   return options?.types? and Array.isArray options.types
 

atom/renderer/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,
-  # Renderer side modules, please sort with alphabet order.
+  ### Renderer side modules, please sort with alphabet order. ###
   desktopCapturer:
     enumerable: true
     get: -> require '../desktop-capturer'

atom/renderer/api/lib/ipc-renderer.coffee

@@ -3,7 +3,7 @@
 binding = process.atomBinding 'ipc'
 v8Util  = process.atomBinding 'v8_util'
 
-# Created by init.coffee.
+### Created by init.coffee. ###
 ipcRenderer = v8Util.getHiddenValue global, 'ipc'
 
 ipcRenderer.send = (args...) ->

atom/renderer/api/lib/ipc.coffee

@@ -1,16 +1,16 @@
 {ipcRenderer, deprecate} = require 'electron'
 {EventEmitter} = require 'events'
 
-# This module is deprecated, we mirror everything from ipcRenderer.
+### This module is deprecated, we mirror everything from ipcRenderer. ###
 deprecate.warn 'ipc module', 'require("electron").ipcRenderer'
 
-# Routes events of ipcRenderer.
+### Routes events of ipcRenderer. ###
 ipc = new EventEmitter
 ipcRenderer.emit = (channel, event, args...) ->
   ipc.emit channel, args...
   EventEmitter::emit.apply ipcRenderer, arguments
 
-# Deprecated.
+### Deprecated. ###
 for method of ipcRenderer when method.startsWith 'send'
   ipc[method] = ipcRenderer[method]
 deprecate.rename ipc, 'sendChannel', 'send'

atom/renderer/api/lib/remote.coffee

@@ -3,7 +3,7 @@ v8Util = process.atomBinding 'v8_util'
 
 callbacksRegistry = new CallbacksRegistry
 
-# Check for circular reference.
+### Check for circular reference. ###
 isCircular = (field, visited) ->
   if typeof field is 'object'
     if field in visited
@@ -11,7 +11,7 @@ isCircular = (field, visited) ->
     visited.push field
   return false
 
-# Convert the arguments object into an array of meta data.
+### Convert the arguments object into an array of meta data. ###
 wrapArgs = (args, visited=[]) ->
   valueToMeta = (value) ->
     if Array.isArray value
@@ -40,7 +40,7 @@ wrapArgs = (args, visited=[]) ->
 
   Array::slice.call(args).map valueToMeta
 
-# Convert meta data from browser into real value.
+### Convert meta data from browser into real value. ###
 metaToValue = (meta) ->
   switch meta.type
     when 'value' then meta.value
@@ -53,43 +53,47 @@ metaToValue = (meta) ->
       throw new Error("#{meta.message}\n#{meta.stack}")
     else
       if meta.type is 'function'
-        # A shadow class to represent the remote function object.
+        ### A shadow class to represent the remote function object. ###
         ret =
         class RemoteFunction
           constructor: ->
             if @constructor == RemoteFunction
-              # Constructor call.
+              ### Constructor call. ###
               obj = ipcRenderer.sendSync 'ATOM_BROWSER_CONSTRUCTOR', meta.id, wrapArgs(arguments)
 
-              # Returning object in constructor will replace constructed object
-              # with the returned object.
-              # http://stackoverflow.com/questions/1978049/what-values-can-a-constructor-return-to-avoid-returning-this
+              ###
+                Returning object in constructor will replace constructed object
+                with the returned object.
+                http://stackoverflow.com/questions/1978049/what-values-can-a-constructor-return-to-avoid-returning-this
+              ###
               return metaToValue obj
             else
-              # Function call.
+              ### Function call. ###
               obj = ipcRenderer.sendSync 'ATOM_BROWSER_FUNCTION_CALL', meta.id, wrapArgs(arguments)
               return metaToValue obj
       else
         ret = v8Util.createObjectWithName meta.name
 
-      # Polulate delegate members.
+      ### Polulate delegate members. ###
       for member in meta.members
         if member.type is 'function'
           ret[member.name] = createRemoteMemberFunction meta.id, member.name
         else
           Object.defineProperty ret, member.name, createRemoteMemberProperty(meta.id, member.name)
 
-      # Track delegate object's life time, and tell the browser to clean up
-      # when the object is GCed.
+      ###
+        Track delegate object's life time, and tell the browser to clean up
+        when the object is GCed.
+      ###
       v8Util.setDestructor ret, ->
         ipcRenderer.send 'ATOM_BROWSER_DEREFERENCE', meta.id
 
-      # Remember object's id.
+      ### Remember object's id. ###
       v8Util.setHiddenValue ret, 'atomId', meta.id
 
       ret
 
-# Construct a plain object from the meta.
+### Construct a plain object from the meta. ###
 metaToPlainObject = (meta) ->
   obj = switch meta.type
     when 'error' then new Error
@@ -97,53 +101,59 @@ metaToPlainObject = (meta) ->
   obj[name] = value for {name, value} in meta.members
   obj
 
-# Create a RemoteMemberFunction instance.
-# This function's content should not be inlined into metaToValue, otherwise V8
-# may consider it circular reference.
+###
+  Create a RemoteMemberFunction instance.
+  This function's content should not be inlined into metaToValue, otherwise V8
+  may consider it circular reference.
+###
 createRemoteMemberFunction = (metaId, name) ->
   class RemoteMemberFunction
     constructor: ->
       if @constructor is RemoteMemberFunction
-        # Constructor call.
+        ### Constructor call. ###
         ret = ipcRenderer.sendSync 'ATOM_BROWSER_MEMBER_CONSTRUCTOR', metaId, name, wrapArgs(arguments)
         return metaToValue ret
       else
-        # Call member function.
+        ### Call member function. ###
         ret = ipcRenderer.sendSync 'ATOM_BROWSER_MEMBER_CALL', metaId, name, wrapArgs(arguments)
         return metaToValue ret
 
-# Create configuration for defineProperty.
-# This function's content should not be inlined into metaToValue, otherwise V8
-# may consider it circular reference.
+###
+  Create configuration for defineProperty.
+  This function's content should not be inlined into metaToValue, otherwise V8
+  may consider it circular reference.
+###
 createRemoteMemberProperty = (metaId, name) ->
   enumerable: true,
   configurable: false,
   set: (value) ->
-    # Set member data.
+    ### Set member data. ###
     ipcRenderer.sendSync 'ATOM_BROWSER_MEMBER_SET', metaId, name, value
     value
   get: ->
-    # Get member data.
+    ### Get member data. ###
     metaToValue ipcRenderer.sendSync('ATOM_BROWSER_MEMBER_GET', metaId, name)
 
-# Browser calls a callback in renderer.
+### Browser calls a callback in renderer. ###
 ipcRenderer.on 'ATOM_RENDERER_CALLBACK', (event, id, args) ->
   callbacksRegistry.apply id, metaToValue(args)
 
-# A callback in browser is released.
+### A callback in browser is released. ###
 ipcRenderer.on 'ATOM_RENDERER_RELEASE_CALLBACK', (event, id) ->
   callbacksRegistry.remove id
 
-# List all built-in modules in browser process.
+### List all built-in modules in browser process. ###
 browserModules = require '../../../browser/api/lib/exports/electron'
-# And add a helper receiver for each one.
+### And add a helper receiver for each one. ###
 for name of browserModules
   do (name) ->
     Object.defineProperty exports, name, get: -> exports.getBuiltin name
 
-# Get remote module.
-# (Just like node's require, the modules are cached permanently, note that this
-#  is safe leak since the object is not expected to get freed in browser)
+###
+  Get remote module.
+  (Just like node's require, the modules are cached permanently, note that this
+  is safe leak since the object is not expected to get freed in browser)
+###
 moduleCache = {}
 exports.require = (module) ->
   return moduleCache[module] if moduleCache[module]?
@@ -151,10 +161,10 @@ exports.require = (module) ->
   meta = ipcRenderer.sendSync 'ATOM_BROWSER_REQUIRE', module
   moduleCache[module] = metaToValue meta
 
-# Optimize require('electron').
+### Optimize require('electron'). ###
 moduleCache.electron = exports
 
-# Alias to remote.require('electron').xxx.
+### Alias to remote.require('electron').xxx. ###
 builtinCache = {}
 exports.getBuiltin = (module) ->
   return builtinCache[module] if builtinCache[module]?
@@ -162,38 +172,38 @@ exports.getBuiltin = (module) ->
   meta = ipcRenderer.sendSync 'ATOM_BROWSER_GET_BUILTIN', module
   builtinCache[module] = metaToValue meta
 
-# Get current BrowserWindow object.
+### Get current BrowserWindow object. ###
 windowCache = null
 exports.getCurrentWindow = ->
   return windowCache if windowCache?
   meta = ipcRenderer.sendSync 'ATOM_BROWSER_CURRENT_WINDOW'
   windowCache = metaToValue meta
 
-# Get current WebContents object.
+### Get current WebContents object. ###
 webContentsCache = null
 exports.getCurrentWebContents = ->
   return webContentsCache if webContentsCache?
   meta = ipcRenderer.sendSync 'ATOM_BROWSER_CURRENT_WEB_CONTENTS'
   webContentsCache = metaToValue meta
 
-# Get a global object in browser.
+### Get a global object in browser. ###
 exports.getGlobal = (name) ->
   meta = ipcRenderer.sendSync 'ATOM_BROWSER_GLOBAL', name
   metaToValue meta
 
-# Get the process object in browser.
+### Get the process object in browser. ###
 processCache = null
 exports.__defineGetter__ 'process', ->
   processCache = exports.getGlobal('process') unless processCache?
   processCache
 
-# Create a funtion that will return the specifed value when called in browser.
+### Create a funtion that will return the specifed value when called in browser. ###
 exports.createFunctionWithReturnValue = (returnValue) ->
   func = -> returnValue
   v8Util.setHiddenValue func, 'returnValue', true
   func
 
-# Get the guest WebContents from guestInstanceId.
+### Get the guest WebContents from guestInstanceId. ###
 exports.getGuestWebContents = (guestInstanceId) ->
   meta = ipcRenderer.sendSync 'ATOM_BROWSER_GUEST_WEB_CONTENTS', guestInstanceId
   metaToValue meta

atom/renderer/api/lib/web-frame.coffee

@@ -1,7 +1,7 @@
 {deprecate} = require 'electron'
 {webFrame} = process.atomBinding 'web_frame'
 
-# Deprecated.
+### Deprecated. ###
 deprecate.rename webFrame, 'registerUrlSchemeAsSecure', 'registerURLSchemeAsSecure'
 deprecate.rename webFrame, 'registerUrlSchemeAsBypassingCSP', 'registerURLSchemeAsBypassingCSP'
 deprecate.rename webFrame, 'registerUrlSchemeAsPrivileged', 'registerURLSchemeAsPrivileged'