Migrate to block comments

atom/common/lib/asar.coffee

@@ -3,7 +3,7 @@ child_process = require 'child_process'
 path = require 'path'
 util = require 'util'
 
-# Cache asar archive objects.
+### Cache asar archive objects. ###
 cachedArchives = {}
 getOrCreateArchive = (p) ->
   archive = cachedArchives[p]
@@ -12,13 +12,15 @@ getOrCreateArchive = (p) ->
   return false unless archive
   cachedArchives[p] = archive
 
-# Clean cache on quit.
+### Clean cache on quit. ###
 process.on 'exit', ->
   archive.destroy() for own p, archive of cachedArchives
 
-# Separate asar package's path from full path.
+### Separate asar package's path from full path. ###
 splitPath = (p) ->
-  return [false] if process.noAsar  # shortcut to disable asar.
+  ### shortcut to disable asar. ###
+  return [false] if process.noAsar
+
   return [false] if typeof p isnt 'string'
   return [true, p, ''] if p.substr(-5) is '.asar'
   p = path.normalize p
@@ -26,7 +28,7 @@ splitPath = (p) ->
   return [false] if index is -1
   [true, p.substr(0, index + 5), p.substr(index + 6)]
 
-# Convert asar archive's Stats object to fs's Stats object.
+### Convert asar archive's Stats object to fs's Stats object. ###
 nextInode = 0
 uid = if process.getuid? then process.getuid() else 0
 gid = if process.getgid? then process.getgid() else 0
@@ -54,7 +56,7 @@ asarStatsToFsStats = (stats) ->
     isSocket: -> false
   }
 
-# Create a ENOENT error.
+### Create a ENOENT error. ###
 notFoundError = (asarPath, filePath, callback) ->
   error = new Error("ENOENT, #{filePath} not found in #{asarPath}")
   error.code = "ENOENT"
@@ -63,7 +65,7 @@ notFoundError = (asarPath, filePath, callback) ->
     throw error
   process.nextTick -> callback error
 
-# Create a ENOTDIR error.
+### Create a ENOTDIR error. ###
 notDirError = (callback) ->
   error = new Error('ENOTDIR, not a directory')
   error.code = 'ENOTDIR'
@@ -72,14 +74,14 @@ notDirError = (callback) ->
     throw error
   process.nextTick -> callback error
 
-# Create invalid archive error.
+### Create invalid archive error. ###
 invalidArchiveError = (asarPath, callback) ->
   error = new Error("Invalid package #{asarPath}")
   unless typeof callback is 'function'
     throw error
   process.nextTick -> callback error
 
-# Override APIs that rely on passing file path instead of content to C++.
+### Override APIs that rely on passing file path instead of content to C++. ###
 overrideAPISync = (module, name, arg = 0) ->
   old = module[name]
   module[name] = ->
@@ -115,7 +117,7 @@ overrideAPI = (module, name, arg = 0) ->
     arguments[arg] = newPath
     old.apply this, arguments
 
-# Override fs APIs.
+### Override fs APIs. ###
 exports.wrapFsWithAsar = (fs) ->
   lstatSync = fs.lstatSync
   fs.lstatSync = (p) ->
@@ -148,7 +150,7 @@ exports.wrapFsWithAsar = (fs) ->
     [isAsar, asarPath, filePath] = splitPath p
     return statSync p unless isAsar
 
-    # Do not distinguish links for now.
+    ### Do not distinguish links for now. ###
     fs.lstatSync p
 
   stat = fs.stat
@@ -156,7 +158,7 @@ exports.wrapFsWithAsar = (fs) ->
     [isAsar, asarPath, filePath] = splitPath p
     return stat p, callback unless isAsar
 
-    # Do not distinguish links for now.
+    ### Do not distinguish links for now. ###
     process.nextTick -> fs.lstat p, callback
 
   statSyncNoException = fs.statSyncNoException
@@ -265,7 +267,9 @@ exports.wrapFsWithAsar = (fs) ->
   openSync = fs.openSync
   readFileSync = fs.readFileSync
   fs.readFileSync = (p, opts) ->
-    options = opts # this allows v8 to optimize this function
+    ### this allows v8 to optimize this function ###
+    options = opts
+
     [isAsar, asarPath, filePath] = splitPath p
     return readFileSync.apply this, arguments unless isAsar
 
@@ -353,17 +357,21 @@ exports.wrapFsWithAsar = (fs) ->
     return internalModuleStat p unless isAsar
 
     archive = getOrCreateArchive asarPath
-    return -34 unless archive  # -ENOENT
+    ### -ENOENT ###
+    return -34 unless archive
 
     stats = archive.stat filePath
-    return -34 unless stats  # -ENOENT
+    ### -ENOENT ###
+    return -34 unless stats
 
     if stats.isDirectory then return 1 else return 0
 
-  # Calling mkdir for directory inside asar archive should throw ENOTDIR
-  # error, but on Windows it throws ENOENT.
-  # This is to work around the recursive looping bug of mkdirp since it is
-  # widely used.
+  ###
+    Calling mkdir for directory inside asar archive should throw ENOTDIR
+    error, but on Windows it throws ENOENT.
+    This is to work around the recursive looping bug of mkdirp since it is
+    widely used.
+  ###
   if process.platform is 'win32'
     mkdir = fs.mkdir
     fs.mkdir = (p, mode, callback) ->

atom/common/lib/asar_init.coffee

@@ -1,13 +1,13 @@
 return (process, require, asarSource) ->
   {createArchive} = process.binding 'atom_common_asar'
 
-  # Make asar.coffee accessible via "require".
+  ### Make asar.coffee accessible via "require". ###
   process.binding('natives').ATOM_SHELL_ASAR = asarSource
 
-  # Monkey-patch the fs module.
+  ### Monkey-patch the fs module. ###
   require('ATOM_SHELL_ASAR').wrapFsWithAsar require('fs')
 
-  # Make graceful-fs work with asar.
+  ### Make graceful-fs work with asar. ###
   source = process.binding 'natives'
   source['original-fs'] = source.fs
   source['fs'] = """

atom/common/lib/init.coffee

@@ -10,15 +10,17 @@ process.atomBinding = (name) ->
     process.binding "atom_common_#{name}" if /No such module/.test e.message
 
 unless process.env.ELECTRON_HIDE_INTERNAL_MODULES
-  # Add common/api/lib to module search paths.
+  ### Add common/api/lib to module search paths. ###
   Module.globalPaths.push path.resolve(__dirname, '..', 'api', 'lib')
 
-# setImmediate and process.nextTick makes use of uv_check and uv_prepare to
-# run the callbacks, however since we only run uv loop on requests, the
-# callbacks wouldn't be called until something else activated the uv loop,
-# which would delay the callbacks for arbitrary long time. So we should
-# initiatively activate the uv loop once setImmediate and process.nextTick is
-# called.
+###
+  setImmediate and process.nextTick makes use of uv_check and uv_prepare to
+  run the callbacks, however since we only run uv loop on requests, the
+  callbacks wouldn't be called until something else activated the uv loop,
+  which would delay the callbacks for arbitrary long time. So we should
+  initiatively activate the uv loop once setImmediate and process.nextTick is
+  called.
+###
 wrapWithActivateUvLoop = (func) ->
   ->
     process.activateUvLoop()
@@ -28,9 +30,11 @@ global.setImmediate = wrapWithActivateUvLoop timers.setImmediate
 global.clearImmediate = timers.clearImmediate
 
 if process.type is 'browser'
-  # setTimeout needs to update the polling timeout of the event loop, when
-  # called under Chromium's event loop the node's event loop won't get a chance
-  # to update the timeout, so we have to force the node's event loop to
-  # recalculate the timeout in browser process.
+  ###
+    setTimeout needs to update the polling timeout of the event loop, when
+    called under Chromium's event loop the node's event loop won't get a chance
+    to update the timeout, so we have to force the node's event loop to
+    recalculate the timeout in browser process.
+  ###
   global.setTimeout = wrapWithActivateUvLoop timers.setTimeout
   global.setInterval = wrapWithActivateUvLoop timers.setInterval

atom/common/lib/reset-search-paths.coffee

@@ -1,21 +1,21 @@
 path   = require 'path'
 Module = require 'module'
 
-# Clear Node's global search paths.
+### Clear Node's global search paths. ###
 Module.globalPaths.length = 0
 
-# Clear current and parent(init.coffee)'s search paths.
+### Clear current and parent(init.coffee)'s search paths. ###
 module.paths = []
 module.parent.paths = []
 
-# Prevent Node from adding paths outside this app to search paths.
+### Prevent Node from adding paths outside this app to search paths. ###
 Module._nodeModulePaths = (from) ->
   from = path.resolve from
 
-  # If "from" is outside the app then we do nothing.
+  ### If "from" is outside the app then we do nothing. ###
   skipOutsidePaths = from.startsWith process.resourcesPath
 
-  # Following logoic is copied from module.js.
+  ### Following logoic is copied from module.js. ###
   splitRe = if process.platform is 'win32' then /[\/\\]/ else /\//
   paths = []