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

Add doc annotation `@shortDescription` to enable explicit synopsis #4991

Merged
merged 1 commit into from Feb 22, 2016

Conversation

Projects
None yet
6 participants
@felixmulder
Contributor

felixmulder commented Feb 22, 2016

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

Add doc annotation `@shortDescription` to enable explicit synopsis
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

@scala-jenkins scala-jenkins added this to the 2.12.0-M4 milestone Feb 22, 2016

@felixmulder

This comment has been minimized.

Show comment
Hide comment
@felixmulder

felixmulder Feb 22, 2016

Contributor

Added a test 👍

Contributor

felixmulder commented Feb 22, 2016

Added a test 👍

@VladUreche

This comment has been minimized.

Show comment
Hide comment
@VladUreche

VladUreche Feb 22, 2016

Member

LGTM. In fact it LVGTM.

Member

VladUreche commented Feb 22, 2016

LGTM. In fact it LVGTM.

VladUreche added a commit that referenced this pull request Feb 22, 2016

Merge pull request #4991 from felixmulder/topic/scaladoc-shortDescrip…
…tion-annotation

Add doc annotation `@shortDescription` to enable explicit synopsis

@VladUreche VladUreche merged commit cce4fc3 into scala:2.12.x Feb 22, 2016

5 checks passed

cla @felixmulder signed the Scala CLA. Thanks!
Details
integrate-ide [1131] SUCCESS. Took 11 s.
Details
validate-main [1350] SUCCESS. Took 65 min.
Details
validate-publish-core [1325] SUCCESS. Took 3 min.
Details
validate-test [1122] SUCCESS. Took 57 min.
Details
@felixmulder

This comment has been minimized.

Show comment
Hide comment
@felixmulder

felixmulder Feb 22, 2016

Contributor

Thanks @VladUreche!

Contributor

felixmulder commented Feb 22, 2016

Thanks @VladUreche!

@felixmulder

This comment has been minimized.

Show comment
Hide comment
@felixmulder

felixmulder Feb 23, 2016

Contributor

Maybe @janekdb should know about this for the scaladoc tutorial? :)

Contributor

felixmulder commented Feb 23, 2016

Maybe @janekdb should know about this for the scaladoc tutorial? :)

@VladUreche

This comment has been minimized.

Show comment
Hide comment
@VladUreche

VladUreche Feb 23, 2016

Member

Yep, thanks for pointing it out Felix!

Member

VladUreche commented Feb 23, 2016

Yep, thanks for pointing it out Felix!

@janekdb

This comment has been minimized.

Show comment
Hide comment
@janekdb

janekdb Feb 23, 2016

Member

Add to list here: scala/scala-lang#394

Member

janekdb commented Feb 23, 2016

Add to list here: scala/scala-lang#394

@adriaanm adriaanm added 2.12.0 and removed 2.12 labels Oct 29, 2016

@lrytz lrytz referenced this pull request Nov 1, 2016

Closed

notes on possible 2.12 release notes improvements #202

12 of 16 tasks complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment