From 0885ae1a966df34c68c9df532f18bf583e7c1380 Mon Sep 17 00:00:00 2001 From: jvican Date: Fri, 28 Apr 2017 01:32:07 +0200 Subject: [PATCH] Add documentation to `updateEither` --- .../internal/librarymanagement/IvyActions.scala | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/librarymanagement/src/main/scala/sbt/internal/librarymanagement/IvyActions.scala b/librarymanagement/src/main/scala/sbt/internal/librarymanagement/IvyActions.scala index 49b0e1091..0c7cef4a6 100644 --- a/librarymanagement/src/main/scala/sbt/internal/librarymanagement/IvyActions.scala +++ b/librarymanagement/src/main/scala/sbt/internal/librarymanagement/IvyActions.scala @@ -203,8 +203,18 @@ object IvyActions { } /** - * Resolves and retrieves dependencies. 'ivyConfig' is used to produce an Ivy file and configuration. - * 'updateConfig' configures the actual resolution and retrieval process. + * Updates one module's dependencies performing a dependency resolution and retrieval. + * + * The following mechanism uses ivy under the hood. + * + * @param module The module to be resolved. + * @param configuration The update configuration. + * @param uwconfig The configuration to handle unresolved warnings. + * @param logicalClock The clock necessary to cache ivy. + * @param depDir The base directory used for caching resolution. + * @param log The logger. + * @return The result, either an unresolved warning or an update report. Note that this + * update report will or will not be successful depending on the `missingOk` option. */ private[sbt] def updateEither( module: IvySbt#Module,