diff --git a/.idea/inspectionProfiles/README.md b/.idea/inspectionProfiles/README.md index a06ad88..3728ae7 100644 --- a/.idea/inspectionProfiles/README.md +++ b/.idea/inspectionProfiles/README.md @@ -1,11 +1,12 @@ # Inspection descriptions -This README file contains descriptions of all inspections in the [config](./Custom_Inspections.xml) file. +This README file contains descriptions of all adapted inspections in the [config](./Custom_Inspections.xml) file. -> [!NOTE] -> This file, as well as the config file, contains only the most common inspections, that have been adapted for better teaching experience. -> For a complete list of inspections available in the IntelliJ platform, see the Kotlin Inspections tab (Settings -> Editor -> Inspections -> Kotlin). +> [!NOTE] +> This file, as well as the config file, contains only the most common inspections, that have been adapted for better learning experience. +> For a complete list of inspections available in the IntelliJ platform, see the Kotlin Inspections tab (Settings -> Editor -> Inspections -> Kotlin). The `Severity` field (`level` in the config file) indicates how the inspections will be displayed in the upper right corner of the editor and in the Problems tab. Some of the possible values are: + | Name | Config name | Example | |--------------|--------------|-----------------------------------------------------------------------------------------------------------------------------------------------------| | Error | ERROR | image | @@ -13,16 +14,16 @@ The `Severity` field (`level` in the config file) indicates how the inspections | Weak Warning | WEAK WARNING | image | The `Highlighting` field (`editorAttributes` in the config file) indicates how the inspection will be highlighted in the IDE. Some of the possible values are: -| Name | Config name | Example | -|---------------|-------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------| + +| Name | Config name | Example | +|---------------|-------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------| | Error | ERRORS_ATTRIBUTES | image | | Warning | WARNING_ATTRIBUTES | image | | Weak Warning | INFO_ATTRIBUTES | image | | Strikethrough | MARKED_FOR_REMOVAL_ATTRIBUTES | image | > [!NOTE] -> To add a new inspection to the config file please use the Kotlin Inspections tab -> where you could turn on/off an inspection and choose its severity and/or highlighting. +> To alter the config file please use the Kotlin Inspections tab where you could turn on/off inspections and choose theirs severity and/or highlighting. ## AddOperatorModifier