feature/table-of-contents

[aktsay6]

What's done:

• Table of contents made

This pull request closes #373

Actions checklist

• Implemented Rule, added Warnings
• Added tests on checks
• Added tests on fixers
• Updated diktat-analysis.yml
• Updated available-rules.md

[codecov]

Codecov Report

Merging #388 into master will increase coverage by 0.53%.
The diff coverage is n/a.

@@             Coverage Diff              @@
##             master     #388      +/-   ##
============================================
+ Coverage     82.55%   83.09%   +0.53%     
+ Complexity     1340     1289      -51     
============================================
  Files            65       64       -1     
  Lines          3251     3147     -104     
  Branches       1042      999      -43     
============================================
- Hits           2684     2615      -69     
+ Misses          177      168       -9     
+ Partials        390      364      -26     

Flag	Coverage Δ	Complexity Δ
#unittests	83.09% <ø> (+0.53%)	1289.00 <ø> (-51.00)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ	Complexity Δ
.../kotlin/org/cqfn/diktat/ruleset/utils/KDocUtils.kt	6.66% <0.00%> (-18.34%)	0.00% <0.00%> (ø%)
...fn/diktat/ruleset/rules/files/FileStructureRule.kt	57.89% <0.00%> (-2.11%)	19.00% <0.00%> (-1.00%)
...fn/diktat/ruleset/rules/StringConcatenationRule.kt	82.35% <0.00%> (-0.99%)	15.00% <0.00%> (ø%)
.../org/cqfn/diktat/ruleset/rules/kdoc/KdocMethods.kt	90.52% <0.00%> (-0.20%)	69.00% <0.00%> (ø%)
...g/cqfn/diktat/ruleset/rules/kdoc/KdocFormatting.kt	75.53% <0.00%> (-0.18%)	75.00% <0.00%> (+2.00%)	⬇️
...tlin/org/cqfn/diktat/ruleset/constants/Warnings.kt	97.05% <0.00%> (-0.06%)	9.00% <0.00%> (ø%)
...cqfn/diktat/ruleset/rules/DiktatRuleSetProvider.kt	98.07% <0.00%> (-0.04%)	3.00% <0.00%> (ø%)
...ktat/ruleset/rules/OverloadingArgumentsFunction.kt
...qfn/diktat/ruleset/utils/search/VariablesSearch.kt	86.20% <0.00%> (+0.49%)	18.00% <0.00%> (ø%)
...tlin/org/cqfn/diktat/ruleset/utils/AstNodeUtils.kt	82.74% <0.00%> (+0.50%)	0.00% <0.00%> (ø%)
... and 10 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 819b631...3468fd7. Read the comment docs.

[orchestr7]

lgtm