javadoc for build scripts updated: do not set custom directories and JAR names for new plugins

This commit is contained in:
nik
2017-04-10 09:20:16 +03:00
parent 3da23def83
commit e64d6cdf70
2 changed files with 7 additions and 4 deletions
@@ -31,7 +31,7 @@ class BaseLayoutSpec {
* 'Runtime' to be copied to the 'lib' directory of the plugin.
*
* @param relativeJarPath target JAR path relative to 'lib' directory of the plugin; different modules may be packed into the same JAR,
* but don't use this for new plugins; this parameter is temporary added to keep layout of old plugins.
* but <strong>don't use this for new plugins</strong>; this parameter is temporary added to keep layout of old plugins.
* @param localizableResourcesInCommonJar if {@code true} the translatable resources from the module (messages, inspection descriptions, etc) will be
* placed into a separate 'resources_en.jar'. <strong>Do not use this for new plugins, this parameter is temporary added to keep layout of old plugins</strong>.
*/
@@ -75,15 +75,18 @@ class PluginLayout extends BaseLayout {
static class PluginLayoutSpec extends BaseLayoutSpec {
private final PluginLayout layout
/**
* Name of the directory (under 'plugins' directory) where the plugin should be placed
* Custom name of the directory (under 'plugins' directory) where the plugin should be placed. By default the main module name is used.
* <strong>Don't set this property for new plugins</strong>; it is temporary added to keep layout of old plugins unchanged.
*/
String directoryName
/**
* Name of the main plugin JAR file
* Custom name of the main plugin JAR file. By default the main module name with 'jar' extension is used.
* <strong>Don't set this property for new plugins</strong>; it is temporary added to keep layout of old plugins unchanged.
*/
String mainJarName
/**
* Version of the plugin if it differs from the global build number
* Version of the plugin if it differs from the global build number.
* <strong>Don't set this property for new plugins</strong>; it is temporary added to keep versioning scheme for some old plugins.
*/
String version