From 799a792f7f03de8d8fdd2f41559e578f806a8539 Mon Sep 17 00:00:00 2001 From: Max Brunsfeld Date: Wed, 18 Nov 2015 13:05:27 -0800 Subject: [PATCH] Remove public docs for DirectorySearch and DefaultDirectorySearcher --- src/default-directory-searcher.coffee | 15 ++++----------- 1 file changed, 4 insertions(+), 11 deletions(-) diff --git a/src/default-directory-searcher.coffee b/src/default-directory-searcher.coffee index 1c9b40312..6b8ffe3e3 100644 --- a/src/default-directory-searcher.coffee +++ b/src/default-directory-searcher.coffee @@ -1,8 +1,7 @@ Task = require './task' -# Public: Searches local files for lines matching a specified regex. -# -# Implements thenable so it can be used with `Promise.all()`. +# Searches local files for lines matching a specified regex. Implements `.then()` +# so that it can be used with `Promise.all()`. class DirectorySearch constructor: (rootPaths, regex, options) -> scanHandlerOptions = @@ -22,31 +21,25 @@ class DirectorySearch @task.terminate() resolve() - # Public: Implementation of `then()` to satisfy the *thenable* contract. - # This makes it possible to use a `DirectorySearch` with `Promise.all()`. - # - # Returns `Promise`. then: (args...) -> @promise.then.apply(@promise, args) - # Public: Cancels the search. cancel: -> # This will cause @promise to reject. @task.cancel() null - # Default provider for the `atom.directory-searcher` service. module.exports = class DefaultDirectorySearcher - # Public: Determines whether this object supports search for a `Directory`. + # Determines whether this object supports search for a `Directory`. # # * `directory` {Directory} whose search needs might be supported by this object. # # Returns a `boolean` indicating whether this object can search this `Directory`. canSearchDirectory: (directory) -> true - # Public: Performs a text search for files in the specified `Directory`, subject to the + # Performs a text search for files in the specified `Directory`, subject to the # specified parameters. # # Results are streamed back to the caller by invoking methods on the specified `options`,