Skip to content

Scaladoc annotations rework #15361

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.

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

Merged
merged 1 commit into from
Jun 10, 2022
Merged

Conversation

pikinier20
Copy link
Contributor

This PR refactors the way Scaladoc picks annotations to show:

  • All annotations are hidden by default
  • Only annotations annotated with @java.lang.annotation.Documented are shown
  • There's a whitelist of annotations from stdlib that should be shown

I would like to ask about which annotations should be whitelisted? I created some rough set but I don't know if it's exhaustive
@odersky @smarter

Comment on lines +45 to +56
val fqNameWhitelist = Set(
"scala.specialized",
"scala.throws",
"scala.transient",
"scala.volatile",
"scala.annotation.experimental",
"scala.annotation.contructorOnly",
"scala.annotation.static",
"scala.annotation.targetName",
"scala.annotation.threadUnsafe",
"scala.annotation.varargs"
)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is the whitelist I've talked about

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The whitelist looks good to me.

@odersky odersky merged commit 30f83f7 into scala:main Jun 10, 2022
@odersky odersky deleted the scaladoc/annotations branch June 10, 2022 16:57
@Kordyjan Kordyjan added this to the 3.2.0 milestone Aug 2, 2023
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.

3 participants