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

Dokka Javadoc's tag parser is case-insensitive #2907

Closed
qwwdfsad opened this issue Mar 8, 2023 · 0 comments · Fixed by #2905
Closed

Dokka Javadoc's tag parser is case-insensitive #2907

qwwdfsad opened this issue Mar 8, 2023 · 0 comments · Fixed by #2905
Labels
bug

Comments

@qwwdfsad
Copy link
Member

qwwdfsad commented Mar 8, 2023

According to Javadoc specification, tags are case-sensitive, meaning that @foo and @Foo are different tags.

Currently, Dokka treats tags in a case-insensitive manner, resolving @param, @PARAM and @pArAm into the standardized @param tag. It would be nice to follow the spec here to avoid surprising behavior.

Additionally, I've verified that IDEA's Javadoc parser also treats tags in a case-sensitive manner
@qwwdfsad qwwdfsad added the bug label Mar 8, 2023
qwwdfsad added a commit that referenced this issue Mar 8, 2023
@qwwdfsad
Improve JavadocParser and fix case-sensitivity
7b6e30f 
* Get rid of safeEnumValueOf that was an unnecessary public API burden and constantly allocating
* Restructure JavadocParser.parseDocTag so it has one lever of nesting less
* Make tag parsing case-sensitive

Fixes #2907
@qwwdfsad qwwdfsad mentioned this issue Mar 8, 2023
Merged
@qwwdfsad qwwdfsad mentioned this issue Mar 17, 2023
Open
qwwdfsad added a commit that referenced this issue Mar 21, 2023
@qwwdfsad
Improve JavadocParser and fix case-sensitivity (#2905)
ff5aa67 
* Get rid of safeEnumValueOf that was an unnecessary public API burden and constantly allocating
* Restructure JavadocParser.parseDocTag, so it has one lever of nesting less
* Make tag parsing case-sensitive

Fixes #2907
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve JavadocParser and fix case-sensitivity Kotlin/dokka
1 participant
@qwwdfsad