unloaded modules: javadocs added

[idea/community.git] / platform / core-api / src / com / intellij / openapi / module / UnloadedModuleDescription.java

diff --git a/platform/core-api/src/com/intellij/openapi/module/UnloadedModuleDescription.java b/platform/core-api/src/com/intellij/openapi/module/UnloadedModuleDescription.java
index 1d4be72a60156d6ab408cff01fcf482dd036483c..7c5f9fb5ff56897b18228de2b5aaeb1adf0b7690 100644 (file)
--- a/platform/core-api/src/com/intellij/openapi/module/UnloadedModuleDescription.java
+++ b/platform/core-api/src/com/intellij/openapi/module/UnloadedModuleDescription.java
@@ -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