Adjust formatting, amend TOCs and update sdkdocs-template

This commit is contained in:
breandan 2015-12-11 15:30:10 -05:00
parent d261d8ff3c
commit ee7f650666
5 changed files with 15 additions and 11 deletions

View File

@ -139,7 +139,8 @@
* [Project Wizard](tutorials/project_wizard.md)
* [Adding New Steps to Project Wizard](tutorials/project_wizard/adding_new_steps.md)
* [Supporting Module Types](tutorials/project_wizard/module_types.md)
<!-- * [Code Inspections](tutorials/code_inspections.md) -->
* [Code Inspections](tutorials/code_inspections.md)
* [Code Intentions](tutorials/code_intentions.md)
* [Run Configurations](tutorials/run_configurations.md)
* [Supporting Frameworks](tutorials/framework.md)
* [Tree Structure View](tutorials/tree_structure_view.md)

@ -1 +1 @@
Subproject commit 9e23d8400c80b3b1e4956c285500e79171a9e218
Subproject commit c69da9ce0ea7ad60634c06773da0b96b07604c09

View File

@ -21,4 +21,8 @@ More detailed explanation of the API components can be found in the
* [Code Inspections](tutorials/code_inspections.md)
* [Run Configurations](tutorials/run_configurations.md)
* [Supporting Frameworks](tutorials/framework.md)
* [Tree Structure View](tutorials/tree_structure_view.md)
* [Tree Structure View](tutorials/tree_structure_view.md)
* [Kotlin for Plugin Developers](tutorials/kotlin.md)
* [Gradle Build System](tutorials/build_system.md)
* [Code Inspections](tutorials/code_inspections.md)
* [Code Intentions](tutorials/code_inspections.md)

View File

@ -12,7 +12,7 @@ You can create custom inspections through the **IntelliJ IDEA** interface (see
### Used Techniques
The **comparing_references_inspection** sample plugin illustrates the use of the following techniques:
The [comparing_refereces_inspection](https://github.com/JetBrains/intellij-sdk-docs/tree/master/code_samples/comparing_references_inspection) sample plugin illustrates the use of the following techniques:
- How to analyze a [PSI tree](http://confluence.jetbrains.net/display/IDEADEV/IntelliJ+IDEA+Architectural+Overview#PsiFiles).
- How to find a Java token of interest in the PSI tree.
@ -24,8 +24,6 @@ The **comparing_references_inspection** sample plugin illustrates the use of t
The **comparingReferences** sample plugin is available in the `<%IntelliJ SDK Docs project%>/code_samples/comparing_references_inspection` directory.
When launched, this plugin adds the **'==' or '!=' instead of 'equals()'** item to the **Probable bugs** node in the [Inspections list](http://www.jetbrains.com/idea/webhelp/inspections-2.html).
![](img/comparingReferences_options.png)
##### Running the Plugin
**To run the sample plugin**
@ -42,7 +40,9 @@ Once the plugin is launched, you can set the plugin options. You can specify the
1. On the IDEA main menu, choose **File | Settings**, and then under **Project Settings**, click **Inspections**.
2. In the list of the IntelliJ IDEA inspections, expand the **Probable bugs** node, and then click **'==' or '!=' instead of 'equals()'**.
![Image](https://confluence.jetbrains.com/download/attachments/36023033/comparingReferences_options.png?version=1&modificationDate=1284998753000&api=v2)
![](img/comparingReferences_options.png)
3. Under **Options**, you can specify the following plugin settings:
- From the **Severity** list, select the severity level of probable bugs the plugin will find (such as Warning, Info, etc.)
- In the text box under **Severity**, specify the semicolon separated list of Java classes to be participated in this code inspection.

View File

@ -13,13 +13,12 @@ You can view a list of all available intention actions using the [Intention Lis
**To display Intention List**
1. Open the **Settings** dialog box.
2. Under **IDE Settings**, click **Intentions**.
This displays the list of all intention actions currently available in **IntelliJ IDEA**. The intention actions are grouped according to the areas of their use.
To enable/disable an intention action, select/clear the check box to its left.
2. Under **IDE Settings**, click **Intentions**. This displays the list of all intention actions currently available in **IntelliJ IDEA**. The intention actions are grouped according to the areas of their use.
3. To enable/disable an intention action, select/deselect the check box to its left.
### Used Techniques
The **conditionalOperatorConverter** sample plugin illustrates the use of the following techniques:
The [conditional_operator_intention](https://github.com/JetBrains/intellij-sdk-docs/tree/master/code_samples/conditional_operator_intention) sample plugin illustrates the use of the following techniques:
- How to analyze a [PSI tree](http://confluence.jetbrains.net/display/IDEADEV/IntelliJ+IDEA+Architectural+Overview#PsiFiles).
- How to find a Java token of interest in the PSI tree.