Skip to content

Add doc annotation @shortDescription to enable explicit synopsis #4991

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.

Sign up for GitHub

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
VladUreche merged 1 commit into from
Feb 22, 2016
Merged

Add doc annotation @shortDescription to enable explicit synopsis #4991

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions src/scaladoc/scala/tools/nsc/doc/base/CommentFactoryBase.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@ trait CommentFactoryBase { this: MemberLookupBase =>
groupDesc0: Map[String,Body] = Map.empty,
groupNames0: Map[String,Body] = Map.empty,
groupPrio0: Map[String,Body] = Map.empty,
hideImplicitConversions0: List[Body] = List.empty
hideImplicitConversions0: List[Body] = List.empty,
shortDescription0: List[Body] = List.empty
): Comment = new Comment {
val body = body0 getOrElse Body(Seq.empty)
val authors = authors0
Expand Down Expand Up @@ -90,9 +91,13 @@ trait CommentFactoryBase { this: MemberLookupBase =>
}
}

override val shortDescription: Option[Text] = shortDescription0.lastOption collect {
case Body(List(Paragraph(Chain(List(Summary(Text(e))))))) if !e.trim.contains("\n") => Text(e)
}

override val hideImplicitConversions: List[String] =
hideImplicitConversions0 flatMap {
case Body(List(Paragraph(Chain(List(Summary(Text(e))))))) if (!e.trim.contains("\n")) => List(e)
case Body(List(Paragraph(Chain(List(Summary(Text(e))))))) if !e.trim.contains("\n") => List(e)
case _ => List()
}
}
Expand Down Expand Up @@ -397,7 +402,8 @@ trait CommentFactoryBase { this: MemberLookupBase =>
groupDesc0 = allSymsOneTag(SimpleTagKey("groupdesc")),
groupNames0 = allSymsOneTag(SimpleTagKey("groupname")),
groupPrio0 = allSymsOneTag(SimpleTagKey("groupprio")),
hideImplicitConversions0 = allTags(SimpleTagKey("hideImplicitConversion"))
hideImplicitConversions0 = allTags(SimpleTagKey("hideImplicitConversion")),
shortDescription0 = allTags(SimpleTagKey("shortDescription"))
)

for ((key, _) <- bodyTags)
Expand Down
8 changes: 6 additions & 2 deletions src/scaladoc/scala/tools/nsc/doc/base/comment/Comment.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,10 @@ abstract class Comment {
Chain(List(inline) ++ stack.reverse)
}

/** A shorter version of the body. Usually, this is the first sentence of the body. */
/** A shorter version of the body. Either from `@shortDescription` or the
* first sentence of the body. */
def short: Inline = {
body.summary match {
shortDescription orElse body.summary match {
case Some(s) =>
closeHtmlTags(s)
case _ =>
Expand Down Expand Up @@ -126,6 +127,9 @@ abstract class Comment {
/** A list of implicit conversions to hide */
def hideImplicitConversions: List[String]

/** A short description used in the entity-view and search results */
def shortDescription: Option[Text]

override def toString =
body.toString + "\n" +
(authors map ("@author " + _.toString)).mkString("\n") +
Expand Down
1 change: 0 additions & 1 deletion test/scaladoc/run/SI-9620.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ object Test extends ScaladocModelTest {
}
"""

// no need for special settings
def scaladocSettings = "-implicits"

def testModel(rootPackage: Package) = {
Expand Down
1 change: 1 addition & 0 deletions test/scaladoc/run/shortDescription-annotation.check
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Done.
55 changes: 55 additions & 0 deletions test/scaladoc/run/shortDescription-annotation.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
import scala.tools.nsc.doc.model._
import scala.tools.partest.ScaladocModelTest

object Test extends ScaladocModelTest {
override def code = """
package a

/** This comment should not appear
* @shortDescription This one should appear
*/
class Foo {
/** This comment should appear */
def foo: Int = 1

/** This comment should not appear
* @shortDescription This comment should appear
*/
def goo: Int = 2
}
"""

// no need for special settings
def scaladocSettings = ""

def testModel(rootPackage: Package) = {
import scala.tools.nsc.doc.base.comment._
import access._

def inlineToStr(inl: Inline): String = inl match {
case Chain(items) => items flatMap (inlineToStr(_)) mkString ""
case Italic(in) => inlineToStr(in)
case Bold(in) => inlineToStr(in)
case Underline(in) => inlineToStr(in)
case Monospace(in) => inlineToStr(in)
case Text(text) => text
case Summary(in) => inlineToStr(in)
case EntityLink(Text(text), _) => text
case _ => inl.toString
}

val foo = rootPackage._package("a")._class("Foo")

// Assert that the class has the correct short description
val classDesc = inlineToStr(foo.comment.get.short)
assert(classDesc == "This one should appear", classDesc)

// Assert that the `foo` method has the correct short description
val fooDesc = inlineToStr(foo._method("foo").comment.get.short)
assert(fooDesc == "This comment should appear", fooDesc)

// Assert that the `goo` method has the correct short description
val gooDesc = inlineToStr(foo._method("goo").comment.get.short)
assert(gooDesc == "This comment should appear", gooDesc)
}
}