Add doc annotation @shortDescription to enable explicit synopsis
#4991
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
Entities with this annotation will be able to control what is shown in the method summary on entity pages as well as the hover text on search results. Review: @VladUreche
felixmulder
force-pushed
the
topic/scaladoc-shortDescription-annotation
branch
from
866e094 to
e521526
Compare
|
Added a test 👍 |
|
LGTM. In fact it LVGTM. |
VladUreche
pushed a commit
that referenced
this pull request
Feb 22, 2016
…tion-annotation Add doc annotation `@shortDescription` to enable explicit synopsis
|
Thanks @VladUreche! |
|
Maybe @janekdb should know about this for the scaladoc tutorial? :) |
|
Yep, thanks for pointing it out Felix! |
|
Add to list here: scala/scala-lang#394 |
16 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Entities with this annotation will be able to control what is shown in
the method summary on entity pages as well as the hover text on search
results.
Review: @VladUreche