From 8a9bccc788ad7bde3371732bdfe336ca5ad41c5e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yann=20C=C3=A9bron?= Date: Tue, 11 Jan 2022 17:20:57 +0100 Subject: [PATCH] code_inspections.md: ability to link Settings from description --- topics/tutorials/code_inspections.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/topics/tutorials/code_inspections.md b/topics/tutorials/code_inspections.md index ea19146e7..e0a5c246d 100644 --- a/topics/tutorials/code_inspections.md +++ b/topics/tutorials/code_inspections.md @@ -1,6 +1,6 @@ [//]: # (title: Code Inspections) - + The IntelliJ Platform provides tools designed for static code analysis called _code inspections_, which help the user maintain and clean up code without actually executing it. Custom code inspections can be implemented as IntelliJ Platform plugins. @@ -125,6 +125,12 @@ Implicit in using [`LocalInspectionTool`](upsource:///platform/analysis-api/src/ * The name of the description file is expected to be the inspection $SHORT_NAME$.html as provided by the inspection description, or the inspection implementation class. If a short name is not provided by the plugin, the IntelliJ Platform computes one by removing `Inspection` suffix from the implementation class name. + > To open related [settings](settings.md) directly from the inspection description, add a link with `settings://$CONFIGURABLE_ID$`, optionally followed by `?$SEARCH_STRING$` to pre-select UI element: + > + > `See Includes tab in Settings | Editor | File and Code Templates to configure.` + > + {type="tip"} + ### Inspection Unit Test > Please note that running the test requires setting system property `idea.home.path` in `test {}` block of build.gradle. >