Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
### What's done:
* Fixes
* Regenerated docs after merge
  • Loading branch information
petertrr committed Jun 17, 2021
1 parent 49a3cb0 commit f0ce960
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
2 changes: 1 addition & 1 deletion info/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ tasks.register("updateMarkdownDocumentation") {
description = "Task that aggregates all documentation updates without white paper updates"
dependsOn(
"generateRulesMapping",
"generateFullDoc",
"generateFullDoc"
)
}

Expand Down
3 changes: 3 additions & 0 deletions info/guide/diktat-coding-convention.md
Original file line number Diff line number Diff line change
Expand Up @@ -870,6 +870,7 @@ Kotlin allows several top-level declaration types: classes, objects, interfaces,
When declaring more than one class or zero classes (e.g. only functions), as per rule [2.2.1](#r2.2.1), you should document the whole file in the header KDoc.
When declaring top-level structures, keep the following order:
1. Top-level constants and properties (following same order as properties inside a class: `const val`,`val`, `lateinit var`, `var`)
2. typealiases (grouped by their visibility modifiers)
2. Interfaces, classes and objects (grouped by their visibility modifiers)
3. Extension functions
4. Other functions
Expand All @@ -885,6 +886,8 @@ const val CONSTANT = 42

val topLevelProperty = "String constant"

internal typealias ExamplesHandler = (IExample) -> Unit

interface IExample

class Example : IExample
Expand Down

0 comments on commit f0ce960

Please sign in to comment.