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/DocParser.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/DocParser.scala')
-rw-r--r-- | src/compiler/scala/tools/nsc/doc/DocParser.scala | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/compiler/scala/tools/nsc/doc/DocParser.scala b/src/compiler/scala/tools/nsc/doc/DocParser.scala index 1e45079c48..2bd80f31da 100644 --- a/src/compiler/scala/tools/nsc/doc/DocParser.scala +++ b/src/compiler/scala/tools/nsc/doc/DocParser.scala @@ -12,8 +12,8 @@ import util._ import interactive.RangePositions import DocParser.Parsed -/** A very minimal global customized for extracting DocDefs. It stops - * right after parsing so it can read DocDefs from source code which would +/** A very minimal global customized for extracting `DocDefs`. It stops + * right after parsing so it can read `DocDefs` from source code which would * otherwise cause the compiler to go haywire. */ class DocParser(settings: nsc.Settings, reporter: Reporter) @@ -31,8 +31,8 @@ class DocParser(settings: nsc.Settings, reporter: Reporter) phasesSet += syntaxAnalyzer } - /** Returns a list of DocParser.Parseds, which hold the DocDefs found in the - * given code along with the surrounding trees. + /** Returns a list of `DocParser.Parseds`, which hold the DocDefs found + * in the given code along with the surrounding trees. */ def docDefs(code: String) = { def loop(enclosing: List[Tree], tree: Tree): List[Parsed] = tree match { @@ -54,7 +54,7 @@ class DocParser(settings: nsc.Settings, reporter: Reporter) } /** Since the DocParser's whole reason for existing involves trashing a - * global, it is designed to bottle up general Global#Tree types rather + * global, it is designed to bottle up general `Global#Tree` types rather * than path dependent ones. The recipient will have to deal. */ object DocParser { |