diff options
author | michelou <michelou@epfl.ch> | 2011-07-15 21:38:03 +0000 |
---|---|---|
committer | michelou <michelou@epfl.ch> | 2011-07-15 21:38:03 +0000 |
commit | 2621ee63285808785159a3c24c9e5a5a723b8b9c (patch) | |
tree | 15d5a0863a7759f7c2178e1c9d29402fc9cd6fb8 /src/compiler/scala/tools/nsc/doc/html/Page.scala | |
parent | a4fb15861b271c41fba8382f3b55024b5fdc8155 (diff) | |
download | scala-2621ee63285808785159a3c24c9e5a5a723b8b9c.tar.gz scala-2621ee63285808785159a3c24c9e5a5a723b8b9c.tar.bz2 scala-2621ee63285808785159a3c24c9e5a5a723b8b9c.zip |
scaladoc fixes and improvements
Changes to scaladoc include:
- fixed transformation of Code(text) into HTML tag <code> - added tool
tips for deprecated entities (classes, methods) using the 'title'
attribute - added syntax highlighting of Scala source code in generated
<pre> blocks (CSS colors are defined in lib/template.css)
Here are several examples of highlighted Scala code:
scala.App
scala.Application
scala.Enumeration
scala.Function1
scala.Function2
scala.native
scala.Option
scala.Proxy
scala.specialized
scala.throws
scala.unchecked
scala.actors.Actor
scala.annotation.deprecatedName
scala.annotation.elidable
scala.annotation.switch
scala.collection.DefaultMap
scala.collection.JavaConversions
scala.collection.JavaConverters
scala.collection.LinearSeqLike
scala.collection.MapLike
scala.collection.SetLike
scala.collection.TraversableLike
scala.collection.immutable.NumericRange
scala.collection.immutable.Range
scala.collection.immutable.Stream
scala.collection.mutable.BufferLike
scala.concurrent.pilib
scala.io.Position
scala.reflect.BeanProperty
scala.reflect.Manifest
scala.testing.Benchmark
scala.util.DynamicVariable
scala.util.control.Breaks
scala.util.control.ControlThrowable
scala.util.control.Exception
scala.util.control.TailCalls
scala.util.logging.Logged
scala.util.parsing.combinator.testing.Tester
scala.util.parsing.json.JSON
scala.util.regexp.WordExp
scala.xml.factory.LoggedNodeFactory
scala.xml.parsing.ConstructingParser
Diffstat (limited to 'src/compiler/scala/tools/nsc/doc/html/Page.scala')
-rw-r--r-- | src/compiler/scala/tools/nsc/doc/html/Page.scala | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/src/compiler/scala/tools/nsc/doc/html/Page.scala b/src/compiler/scala/tools/nsc/doc/html/Page.scala index f72b0a49eb..c5bf3e0e37 100644 --- a/src/compiler/scala/tools/nsc/doc/html/Page.scala +++ b/src/compiler/scala/tools/nsc/doc/html/Page.scala @@ -1,4 +1,10 @@ +/* NSC -- new Scala compiler + * Copyright 2007-2011 LAMP/EPFL + * @author David Bernard, Manohar Jonnalagedda + */ + package scala.tools.nsc.doc.html + import scala.tools.nsc.doc.model._ import java.io.{FileOutputStream, File} import scala.reflect.NameTransformer @@ -6,9 +12,10 @@ import scala.reflect.NameTransformer abstract class Page { thisPage => - /** The path of this page, relative to the API site. `path.tail` is a list of folder names leading to this page (from - * closest package to one-above-root package), `path.head` is the file name of this page. Note that `path` has a - * length of at least one. */ + /** The path of this page, relative to the API site. `path.tail` is a list + * of folder names leading to this page (from closest package to + * one-above-root package), `path.head` is the file name of this page. + * Note that `path` has a length of at least one. */ def path: List[String] def absoluteLinkTo(path: List[String]) = path.reverse.mkString("/") @@ -22,8 +29,8 @@ abstract class Page { new FileOutputStream(file.getPath) } - /** Writes this page as a file. The file's location is relative to the generator's site root, and the encoding is - * also defined by the generator. + /** Writes this page as a file. The file's location is relative to the + * generator's site root, and the encoding is also defined by the generator. * @param generator The generator that is writing this page. */ def writeFor(site: HtmlFactory): Unit |