From df0d7404d4bf1c657609ab0193b350cae42a2d3a Mon Sep 17 00:00:00 2001 From: nik Date: Wed, 6 Feb 2019 12:03:03 +0300 Subject: [PATCH] build scripts: improve javadoc in testing gant scripts --- build/scripts/tests_in_community.gant | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/build/scripts/tests_in_community.gant b/build/scripts/tests_in_community.gant index 7f7aabd5bea7..6352bb9d7278 100644 --- a/build/scripts/tests_in_community.gant +++ b/build/scripts/tests_in_community.gant @@ -18,8 +18,13 @@ import org.jetbrains.intellij.build.impl.CompilationContextImpl import org.jetbrains.jps.idea.IdeaProjectLoader /** - * Compiles the sources and runs tests from 'community' project. Look at org.jetbrains.intellij.build.TestingOptions to see which options are - * supported. + * Compiles the sources and runs tests from 'community' project. Look at {@link org.jetbrains.intellij.build.TestingOptions} to see which + * options are supported. + * + * If you want to run this script from IntelliJ IDEA, it's important to add 'Build Project' step in 'Before Launch' section of the created + * run configuration to ensure that required files are compiled before the script starts. It also makes sense to have + * {@linkplain org.jetbrains.intellij.build.BuildOptions#USE_COMPILED_CLASSES_PROPERTY '-Dintellij.build.use.compiled.classes=true'} in 'VM Options' + * to skip compilation and use the compiled classes from the project output. */ target("default": "Run tests") { String home = IdeaProjectLoader.guessHome(this)