Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make KDocs on overriden functions/properties not mandatory #551

Closed
petertrr opened this issue Nov 19, 2020 · 1 comment · Fixed by #565 or #594
Closed

Make KDocs on overriden functions/properties not mandatory #551

petertrr opened this issue Nov 19, 2020 · 1 comment · Fixed by #565 or #594
Assignees
@aktsay6
Milestone
diktat should be ...

Comments

@petertrr
Copy link
Member

petertrr commented Nov 19, 2020 •
edited
Loading

Or even false by default, because dokka uses parent class documentation when generating docs.
@petertrr petertrr mentioned this issue Nov 19, 2020
Merged
@kentr0w kentr0w assigned kentr0w and unassigned kentr0w Nov 19, 2020
@aktsay6 aktsay6 self-assigned this Nov 24, 2020
aktsay6 added a commit that referenced this issue Nov 24, 2020
@aktsay6
bugfix/make-kdoc-functions-not-mandatory(#551)
3c10539 
### What's done:
  * Fixed bugs
@aktsay6 aktsay6 mentioned this issue Nov 24, 2020
Merged
aktsay6 added a commit that referenced this issue Nov 24, 2020
@aktsay6
Merge branch 'master' into bugfix/make-kdocs-functions-not-mandatory(#…
8399da9 
…551)
aktsay6 added a commit that referenced this issue Nov 24, 2020
@aktsay6
bugfix/make-kdoc-functions-not-mandatory(#551) (#565)
0bc75c8 
### What's done:
  * Fixed bugs
@petertrr petertrr reopened this Nov 26, 2020
@petertrr
Copy link
Member Author

petertrr commented Nov 26, 2020 •
edited
Loading

This should be supported in KdocMethods too, better to add a test to smoke tests and ensure no one is adding these docs. There are currently other inspections for the same thing: KDOC_WITHOUT_PARAM_TAG, MISSING_KDOC_ON_FUNCTION.

aktsay6 added a commit that referenced this issue Nov 30, 2020
@aktsay6
bugfix/overriden-kdoc-not-mandatory(#551)
040949b 
### What's done:
  * Fixed bugs
@aktsay6 aktsay6 mentioned this issue Nov 30, 2020
Merged
petertrr added a commit that referenced this issue Nov 30, 2020
@petertrr
Merge branch 'master' into bugfix/overriden-kdoc-not-mandatory(#551)
1387770
aktsay6 added a commit that referenced this issue Nov 30, 2020
@aktsay6
bugfix/overriden-kdoc-not-mandatory(#551)
fd1f5eb 
### What's done:
  * Fixed bugs
aktsay6 added a commit that referenced this issue Nov 30, 2020
@aktsay6
Merge remote-tracking branch 'origin/bugfix/overriden-kdoc-not-mandat…
21b7f90 
…ory(#551)' into bugfix/overriden-kdoc-not-mandatory(#551)
aktsay6 added a commit that referenced this issue Nov 30, 2020
@aktsay6
Bugfix. KdocMethod should not raise warning on override fun (#594)
6d4a8ef 
* bugfix/overriden-kdoc-not-mandatory(#551)

### What's done:
  * Fixed bugs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@aktsay6 aktsay6

Labels
None yet
Projects
None yet
Milestone
diktat should be self-checked
3 participants
@petertrr @kentr0w @aktsay6