Skip to content

Fold @param and @return KDoc tags into the description prose - #37

Merged
DmitryNekrasov merged 1 commit into
mainfrom
kdoc-inline-param-return
Jun 26, 2026
Merged

DmitryNekrasov merged 1 commit into
mainfrom
kdoc-inline-param-return

Conversation

@DmitryNekrasov

Copy link
Copy Markdown
Owner

The Kotlin coding convention recommends against @param/@return tags, preferring parameter and return descriptions inline in the prose with [name] links. This change applies that across the public KDoc in commonMain: each tag's content moves into the description, keeping all parameter constraints, defaults, and return behavior. @throws, @see, @sample, and @constructor are untouched, as are the already-compliant Long overloads of gcd/lcm and the count property.

Docs only, no API or behavior change. Dokka still generates cleanly, so every [name] link resolves (it runs with failOnWarning).

The Kotlin coding convention recommends describing parameters and return values inline with [name] links rather than dedicated tags.
@DmitryNekrasov DmitryNekrasov self-assigned this Jun 26, 2026
@DmitryNekrasov
DmitryNekrasov merged commit b090001 into main Jun 26, 2026
1 check passed
@DmitryNekrasov
DmitryNekrasov deleted the kdoc-inline-param-return branch June 26, 2026 13:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant