Skip to content

Commit

Permalink
cr: add param comments
Browse files Browse the repository at this point in the history
  • Loading branch information
radeusgd committed Jun 29, 2021
1 parent bb03f12 commit 67826d2
Showing 1 changed file with 22 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,26 @@ import scala.concurrent.{ExecutionContext, Future}
*/
trait ContentRootManager {

/** Lists the content roots currently available. */
/** Lists the content roots currently available.
*
* @param ec the execution context on which to wait for the reply from the
* content root manager
* @return a future that will complete with a list of currently available
* content roots
*/
def getContentRoots(implicit
ec: ExecutionContext
): Future[List[ContentRootWithFile]]

/** Finds the content root with the given id. */
/** Finds the content root with the given id.
*
* @param id the id of the content root to get
* @param ec the execution context on which to wait for the reply from the
* content root manager
* @return a future that will complete either with the found content root or
* with an error if a content root with the requested id was not
* found
*/
def findContentRoot(id: UUID)(implicit
ec: ExecutionContext
): Future[Either[ContentRootNotFound.type, ContentRootWithFile]]
Expand All @@ -29,6 +43,12 @@ trait ContentRootManager {
* The implementation should pick the most specific content root for the
* path, i.e. the one whose root location shares the longest common prefix
* with the path that is being resolved.
*
* @param path the path to convert
* @param ec the execution context on which to wait for the reply from the
* content root manager
* @return a future that will complete with the relativized path or None if
* the path was not relative to any of the available roots
*/
def findRelativePath(path: File)(implicit
ec: ExecutionContext
Expand Down

0 comments on commit 67826d2

Please sign in to comment.