From 6bc9d57ee62352c9e3f51b23db4ac30c69fc9cd5 Mon Sep 17 00:00:00 2001 From: Sergey Savenko Date: Wed, 17 Jun 2015 11:52:36 +0300 Subject: [PATCH] add ExtensionsRootType javadoc --- .../ide/extensionResources/ExtensionsRootType.java | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/platform/lang-impl/src/com/intellij/ide/extensionResources/ExtensionsRootType.java b/platform/lang-impl/src/com/intellij/ide/extensionResources/ExtensionsRootType.java index b84db1ec1ad3..7c90afa0719a 100644 --- a/platform/lang-impl/src/com/intellij/ide/extensionResources/ExtensionsRootType.java +++ b/platform/lang-impl/src/com/intellij/ide/extensionResources/ExtensionsRootType.java @@ -40,6 +40,15 @@ import java.security.MessageDigest; import java.security.NoSuchAlgorithmException; import java.util.Enumeration; +/** + *

Extensions root type provide a common interface for plugins to access resources that are modifiable by the user.

+ *

Plugin's resources are stored in a directory named %plugin-id% under extensions root.

+ *

+ * Plugins can bundle default resources. Bundled resources are searched via {@link ClassLoader#getResources(String)} + * call to plugin's class loader passing {@link ExtensionsRootType#EXTENSIONS_PATH} concatenated with relative resource path as an argument. + *

+ *

Bundled resources are updated automatically upon plugin version change. For bundled plugins, application version is used.

+ */ public class ExtensionsRootType extends RootType { public static final String EXTENSIONS_PATH = "extensions"; public static final String BACKUP_FILE_EXTENSION = "old";