unloaded modules: javadocs added appcode/173.125 clion/173.126
authornik <Nikolay.Chashnikov@jetbrains.com>
Mon, 12 Jun 2017 08:45:22 +0000 (10:45 +0200)
committernik <Nikolay.Chashnikov@jetbrains.com>
Mon, 12 Jun 2017 08:45:22 +0000 (10:45 +0200)
platform/core-api/src/com/intellij/openapi/module/UnloadedModuleDescription.java
platform/core-api/src/com/intellij/openapi/roots/FileIndexFacade.java
platform/projectModel-api/src/com/intellij/openapi/module/ModuleManager.java

index 1d4be72a60156d6ab408cff01fcf482dd036483c..7c5f9fb5ff56897b18228de2b5aaeb1adf0b7690 100644 (file)
@@ -22,6 +22,9 @@ import org.jetbrains.annotations.NotNull;
 import java.util.List;
 
 /**
+ * Represents a module which is unloaded from the project. Such modules aren't shown in UI (except for a special 'Load/Unload Modules' dialog),
+ * all of their contents is excluded from the project so it isn't indexed or compiled.
+ *
  * @author nik
  */
 @ApiStatus.Experimental
index 4b0a997d6b24a202f4706bb840aa5bac95a0bd0a..8ab403b99bc93b039965b4c0bd5a3396077786be 100644 (file)
@@ -69,6 +69,10 @@ public abstract class FileIndexFacade {
 
   @NotNull public abstract ModificationTracker getRootModificationTracker();
 
+  /**
+   * @return descriptions of all modules which are unloaded from the project
+   * @see UnloadedModuleDescription
+   */
   @NotNull
   public abstract Collection<UnloadedModuleDescription> getUnloadedModuleDescriptions();
 }
index a4f3e881ca55543d90779f71b4d28fc9494117f4..53ef2ea5e4ef4b14e9da7d262ae760757e5da2e3 100644 (file)
@@ -187,8 +187,8 @@ public abstract class ModuleManager extends SimpleModificationTracker {
   public abstract UnloadedModuleDescription getUnloadedModuleDescription(@NotNull String moduleName);
 
   /**
-   * Specify list of modules which will be unloaded from the project. These modules won't be shown in UI, all of their contents will be excluded
-   * from indexing and compilation.
+   * Specify list of modules which will be unloaded from the project.
+   * @see UnloadedModuleDescription
    */
   @ApiStatus.Experimental
   public abstract void setUnloadedModules(@NotNull List<String> unloadedModuleNames);