diff options
author | Gilles Dubochet <gilles.dubochet@epfl.ch> | 2010-03-24 16:59:22 +0000 |
---|---|---|
committer | Gilles Dubochet <gilles.dubochet@epfl.ch> | 2010-03-24 16:59:22 +0000 |
commit | d43ccc679de41aca085072d96a61e363e5e23e34 (patch) | |
tree | 803b33d6e9e7c7116a97687d2963c666571a2bd9 /src/compiler/scala/tools/nsc/doc/html/HtmlFactory.scala | |
parent | c7c8981b43a6df71e088b444dacf53d609a21ffc (diff) | |
download | scala-d43ccc679de41aca085072d96a61e363e5e23e34.tar.gz scala-d43ccc679de41aca085072d96a61e363e5e23e34.tar.bz2 scala-d43ccc679de41aca085072d96a61e363e5e23e34.zip |
[scaladoc] Improved Scaladoc comment syntax, co...
[scaladoc] Improved Scaladoc comment syntax, contributed by Pedro
Furlanetto.
- Wiki syntax supports nested, numbered and unnumbered lists;
- Wiki syntax supports links (entity links currently require fully qualified names);
- Stars no longer are mandatory to start comment lines.
Already reviewed by dubochet; no review.
Diffstat (limited to 'src/compiler/scala/tools/nsc/doc/html/HtmlFactory.scala')
-rw-r--r-- | src/compiler/scala/tools/nsc/doc/html/HtmlFactory.scala | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/compiler/scala/tools/nsc/doc/html/HtmlFactory.scala b/src/compiler/scala/tools/nsc/doc/html/HtmlFactory.scala index a78c122798..f01984052f 100644 --- a/src/compiler/scala/tools/nsc/doc/html/HtmlFactory.scala +++ b/src/compiler/scala/tools/nsc/doc/html/HtmlFactory.scala @@ -16,19 +16,19 @@ import scala.collection._ /** A class that can generate Scaladoc sites to some fixed root folder. * @author David Bernard * @author Gilles Dubochet */ -class HtmlFactory(val reporter: Reporter, val settings: Settings) { +class HtmlFactory(val universe: Universe) { /** The character encoding to be used for generated Scaladoc sites. This value is currently always UTF-8. */ def encoding: String = "UTF-8" /** The character encoding to be used for generated Scaladoc sites. This value is defined by the generator's * settings. */ - def siteRoot: File = new File(settings.outdir.value) + def siteRoot: File = new File(universe.settings.outdir.value) /** Generates the Scaladoc site for a model into the site toot. A scaladoc site is a set of HTML and related files * that document a model extracted from a compiler run. * @param model The model to generate in the form of a sequence of packages. */ - def generate(modelRoot: Package): Unit = { + def generate(universe: Universe): Unit = { def copyResource(subPath: String) { val buf = new Array[Byte](1024) @@ -67,7 +67,7 @@ class HtmlFactory(val reporter: Reporter, val settings: Settings) { copyResource("lib/filter_box_right.png") copyResource("lib/remove.png") - new page.Index(modelRoot) writeFor this + new page.Index(universe) writeFor this val written = mutable.HashSet.empty[DocTemplateEntity] @@ -77,7 +77,7 @@ class HtmlFactory(val reporter: Reporter, val settings: Settings) { tpl.templates filter { t => !(written contains t) } map (writeTemplate(_)) } - writeTemplate(modelRoot) + writeTemplate(universe.rootPackage) } |