search

Tomm0017 / rsmod

New repository: https://github.com/rsmod/rsmod
https://github.com/rsmod/rsmod
Apache License 2.0
123 stars 100 forks source link

Don't use javadoc/kdoc documentation style where it is not applicable. #69

Closed notmeta closed 5 years ago

notmeta commented 5 years ago

Example: https://github.com/Tomm0017/rsmod/blob/master/game/plugins/src/main/kotlin/gg/rsmod/plugins/content/osrs.kts

Javadoc/KDoc is used to document methods, classes, members etc. rather than as casual comments explaining some code.

https://kotlinlang.org/docs/reference/kotlin-doc.html#kdoc-syntax

Tomm0017 commented 5 years ago

Fixed in https://github.com/Tomm0017/rsmod/commit/2fb34b567744bb6a60cb3c7318285da66146d6e6