summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorPedro Furlanetto <pedrofurla@gmail.com>2011-05-30 01:46:39 +0000
committerPedro Furlanetto <pedrofurla@gmail.com>2011-05-30 01:46:39 +0000
commit6daacd386b272a998f69f7b7ee902c44000c7a99 (patch)
tree7499b0ae9e8bac4dd379549e63571052e5ba3d25 /src
parenta8926ae0b28d606e240f409adca69f1d91f45990 (diff)
downloadscala-6daacd386b272a998f69f7b7ee902c44000c7a99.tar.gz
scala-6daacd386b272a998f69f7b7ee902c44000c7a99.tar.bz2
scala-6daacd386b272a998f69f7b7ee902c44000c7a99.zip
Adds support for @note in ScalaDoc.
Diffstat (limited to 'src')
-rw-r--r--src/compiler/scala/tools/nsc/doc/html/page/Template.scala11
1 files changed, 10 insertions, 1 deletions
diff --git a/src/compiler/scala/tools/nsc/doc/html/page/Template.scala b/src/compiler/scala/tools/nsc/doc/html/page/Template.scala
index b701e0e2ad..40e0ca930a 100644
--- a/src/compiler/scala/tools/nsc/doc/html/page/Template.scala
+++ b/src/compiler/scala/tools/nsc/doc/html/page/Template.scala
@@ -407,6 +407,15 @@ class Template(tpl: DocTemplateEntity) extends HtmlPage {
<dd>{ for(body <- comment.since.toList) yield {bodyToHtml(body)} }</dd>
} else NodeSeq.Empty
+ val note: Seq[scala.xml.Node] =
+ if(!comment.note.isEmpty && !isReduced) {
+ <dt>Note</dt>
+ <dd>{
+ val noteXml: List[scala.xml.NodeSeq] = (for(note <- comment.note ) yield <span class="cmt">{bodyToHtml(note)}</span> )
+ noteXml.reduceLeft(_ ++ Text(", ") ++ _)
+ }</dd>
+ } else NodeSeq.Empty
+
val seeAlso: Seq[scala.xml.Node] =
if(!comment.see.isEmpty && !isReduced) {
<dt>See also</dt>
@@ -416,7 +425,7 @@ class Template(tpl: DocTemplateEntity) extends HtmlPage {
}</dd>
} else NodeSeq.Empty
- example ++ version ++ sinceVersion ++ seeAlso
+ example ++ version ++ sinceVersion ++ note ++ seeAlso
case None => NodeSeq.Empty
}