diff options
author | chrisJames <chrisJames@epfl.ch> | 2010-08-12 11:58:52 +0000 |
---|---|---|
committer | chrisJames <chrisJames@epfl.ch> | 2010-08-12 11:58:52 +0000 |
commit | 596ef0e94b3b4ea1b43b5eba49c5af014067798d (patch) | |
tree | ab94857ad03cc8786f03fea24c20123ac6943481 /src/compiler/scala/tools/nsc/doc/html/page/Template.scala | |
parent | b781e25afea36e2839d207125d3b91b35571d8ec (diff) | |
download | scala-596ef0e94b3b4ea1b43b5eba49c5af014067798d.tar.gz scala-596ef0e94b3b4ea1b43b5eba49c5af014067798d.tar.bz2 scala-596ef0e94b3b4ea1b43b5eba49c5af014067798d.zip |
[Scaladoc] Improve the documentation of primary...
[Scaladoc] Improve the documentation of primary constructor. Adds a
@constructor for commenting the primary constructor. It also adds some
comments for the primary constructor (@params, @deprecated) which
are initialised in the class comment. Members that come from primary
constructor parameters (val parameters or parameters of a case class)
are listed as members with the comment given using the @param tag
(closes #254, closes #577). Case class signature now begins by 'case
class' instead of 'class'. Review by dubochet
Diffstat (limited to 'src/compiler/scala/tools/nsc/doc/html/page/Template.scala')
-rw-r--r-- | src/compiler/scala/tools/nsc/doc/html/page/Template.scala | 8 |
1 files changed, 3 insertions, 5 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 324b04a54f..a4c100884b 100644 --- a/src/compiler/scala/tools/nsc/doc/html/page/Template.scala +++ b/src/compiler/scala/tools/nsc/doc/html/page/Template.scala @@ -52,7 +52,7 @@ class Template(tpl: DocTemplateEntity) extends HtmlPage { } <div id="definition"> - <img src={ relativeLinkTo(List(kindToString(tpl) + "_big.png", "lib")) }/> + <img src={ relativeLinkTo(List(docEntityKindToBigImage(tpl), "lib")) }/> <h1>{ if (tpl.isRootPackage) "root package" else tpl.name }</h1> </div> @@ -210,8 +210,7 @@ class Template(tpl: DocTemplateEntity) extends HtmlPage { <div class="comment cmt">{ commentToHtml(mbr.comment) }</div> } ++ { val prs: List[ParameterEntity] = mbr match { - case cls: Class if cls.isCaseClass => - cls.typeParams ::: (cls.primaryConstructor map (_.valueParams.flatten)).toList.flatten + case cls: Class => cls.typeParams ::: cls.valueParams.flatten case trt: Trait => trt.typeParams case dfe: Def => dfe.typeParams ::: dfe.valueParams.flatten case ctr: Constructor => ctr.valueParams.flatten @@ -425,8 +424,7 @@ class Template(tpl: DocTemplateEntity) extends HtmlPage { vlsss map { vlss => <span class="params">({implicitCheck(vlss) ++ params0(vlss) })</span> } } mbr match { - case cls: Class if cls.isCaseClass && cls.primaryConstructor.isDefined => - paramsToHtml(cls.primaryConstructor.get.valueParams) + case cls: Class => paramsToHtml(cls.valueParams) case ctr: Constructor => paramsToHtml(ctr.valueParams) case dfe: Def => paramsToHtml(dfe.valueParams) case _ => NodeSeq.Empty |