diff --git a/src/project.coffee b/src/project.coffee index 2c37ccf63..55bf2cf30 100644 --- a/src/project.coffee +++ b/src/project.coffee @@ -50,14 +50,14 @@ class Project extends Model # # An {Editor} will be used if no openers return a value. # - # ## Example: + # ## 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. + # opener - A {Function} to be called when a path is being opened. registerOpener: (opener) -> @openers.push(opener) # Public: Remove a previously registered opener. @@ -108,8 +108,7 @@ class Project extends Model # 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 + # uri - The {String} name of the path to convert. # # Returns a String. resolve: (uri) -> @@ -133,10 +132,8 @@ class Project extends Model # Public: Given a path to a file, this constructs and associates a new # {Editor}, showing the file. # - # * filePath: - # The {String} path of the file to associate with - # * options: - # Options that you can pass to the {Editor} constructor + # filePath - The {String} path of the file to associate with. + # options - Options that you can pass to the {Editor} constructor. # # Returns a promise that resolves to an {Editor}. open: (filePath, options={}) -> @@ -218,8 +215,8 @@ class Project extends Model # Given a file path, this sets its {TextBuffer}. # - # absoluteFilePath - A {String} representing a path - # text - The {String} text to use as a buffer + # absoluteFilePath - A {String} representing a path. + # text - The {String} text to use as a buffer. # # Returns a promise that resolves to the {TextBuffer}. buildBuffer: (absoluteFilePath) -> @@ -252,12 +249,10 @@ class Project extends Model # 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 @@ -296,10 +291,11 @@ class Project extends Model # Public: Performs a replace across all the specified files in the project. # - # * regex: A RegExp to search with - # * replacementText: Text to replace all matches of regex with - # * filePaths: List of file path strings to run the replace on. - # * iterator: A Function callback on each file with replacements. `({filePath, replacements}) ->` + # regex - A {RegExp} to search with. + # replacementText - Text to replace all matches of regex with + # filePaths - List of file path strings to run the replace on. + # iterator - A {Function} callback on each file with replacements: + # `({filePath, replacements}) ->`. replace: (regex, replacementText, filePaths, iterator) -> deferred = Q.defer()