introduce scala.annotation.documented
#23770
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hamzaremmal
added
area:annotations
area:documentation
area:doctool
area:library
hamzaremmal
commented
Aug 16, 2025
| * environment. | ||
| */ | ||
| @experimental | ||
| @experimental @documented |
Member
Author
There was a problem hiding this comment.
One change compared to the previous behavior, this means all the @use annotations of CC will be in the doc even when we suppress cc in scaladoc.
Member
Author
There was a problem hiding this comment.
@use will be deprecated soon.
hamzaremmal
force-pushed
the
add-documented
branch
from
82239f4 to
02fab3f
Compare
Member
Author
|
The failures in the CI are actually bugs in scaladoc. I'll fill the issue for it shortly. |
hamzaremmal
commented
Aug 16, 2025
Comment on lines
-47
to
-56
| "scala.specialized", | ||
| "scala.throws", | ||
| "scala.transient", | ||
| "scala.volatile", | ||
| "scala.annotation.experimental", | ||
| "scala.annotation.constructorOnly", | ||
| "scala.annotation.static", | ||
| "scala.annotation.targetName", | ||
| "scala.annotation.threadUnsafe", | ||
| "scala.annotation.varargs", |
Member
Author
There was a problem hiding this comment.
This list was useless as all the symbols in the annotations are symbols to the constructors.
As an example, we should have had scala.annotation.experimental.<init> instead of scala.annotation.experimental.
Since the intention is to have these annotations as documented, I will update the tests that failed to include them.
hamzaremmal
force-pushed
the
add-documented
branch
from
433bdf4 to
453e75d
Compare
This was referenced Nov 16, 2025
hamzaremmal
force-pushed
the
add-documented
branch
2 times, most recently
from
1c4e6f9 to
3320f33
Compare
hamzaremmal
added a commit
that referenced
this pull request
Nov 26, 2025
hamzaremmal
force-pushed
the
add-documented
branch
from
3320f33 to
4188ca7
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
TODO:
java.lang.annotation.Documentedinscala.annotation.documentedjava.lang.annotation.Documentedor drop it?