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.

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

Scaladoc class member inconsistency #8514

Closed
scabug opened this issue Apr 18, 2014 · 4 comments
Closed

Scaladoc class member inconsistency #8514

scabug opened this issue Apr 18, 2014 · 4 comments
Assignees
Milestone

Comments

@scabug
Copy link

scabug commented Apr 18, 2014

package a {
  class DeveloperApi extends scala.annotation.StaticAnnotation

  /** Some doc here */
  @DeveloperApi
  class A

  @DeveloperApi
  class B
}

Class A gets a simple comment (Some doc here) but not the annotation. Class B gets the annotation.

Tracked the problem down to: https://github.com/scala/scala/blob/cac6383e6658dc5956540b76b9b46c3b664774ac/src/scaladoc/scala/tools/nsc/doc/html/page/Template.scala#L309-L311. It basically says: if the member gets its own page, and the doc comment is defined, don't generate anything but the doc comment. In our case, A has a doc comment and B doesn't, therefore A only gets the doc comment while B gets the full comment, including the annotation => inconsistency.

@scabug
Copy link
Author

scabug commented Apr 18, 2014

Imported From: https://issues.scala-lang.org/browse/SI-8514?orig=1
Reporter: @VladUreche
Affected Versions: 2.11.0
Attachments:

@scabug
Copy link
Author

scabug commented Apr 18, 2014

@scabug
Copy link
Author

scabug commented Apr 21, 2014

@retronym said:
scala/scala#3685

@scabug
Copy link
Author

scabug commented May 7, 2014

@VladUreche said:
PR merged.

@scabug scabug closed this as completed May 7, 2014
@scabug scabug added this to the 2.11.1 milestone Apr 7, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants