 
   # Public: Performs a search across all the files in the project.
   #
-  # * regex:
-  #   A RegExp to search with
-  # * options:
-  #   - paths: an {Array} of glob patterns to search within
-  # * iterator:
-  #   A Function callback on each file found
+  # regex - A {RegExp} to search with.
+  # options - An optional options {Object} (default: {}):
+  #   :paths - An {Array} of glob patterns to search within
+  # iterator - A {Function} callback on each file found
   scan: (regex, options={}, iterator) ->
     if _.isFunction(options)
       iterator = options

  # the path is already absolute or if it is prefixed with a scheme, it is
  # returned unchanged.
  #
  # * uri:
  #   The String name of the path to convert
  #
  # Returns a String.
  resolve: (uri) ->

  #
  # An {Editor} will be used if no openers return a value.
  #
  # ## Example
  # ```coffeescript
  #   atom.project.registerOpener (filePath) ->
  #     if path.extname(filePath) is '.toml'
  #       return new TomlEditor(filePath)
  # ```
  #
  # opener - A {Function} to be called when a path is being opened.
  registerOpener: (opener) -> @openers.push(opener)

  # Public: Remove a previously registered opener.
