diff options
author | michelou <michelou@epfl.ch> | 2011-07-13 20:31:32 +0000 |
---|---|---|
committer | michelou <michelou@epfl.ch> | 2011-07-13 20:31:32 +0000 |
commit | 5e49b4181976f20d28625008a775223dbf8e7f6e (patch) | |
tree | 7c6b89abee9c86801614b8fa081f3cf88bcfe6f6 /src/manual | |
parent | c614e932d01668cda6506fcb431a2f719f0a71f0 (diff) | |
download | scala-5e49b4181976f20d28625008a775223dbf8e7f6e.tar.gz scala-5e49b4181976f20d28625008a775223dbf8e7f6e.tar.bz2 scala-5e49b4181976f20d28625008a775223dbf8e7f6e.zip |
cleanups (scaladoc 2, deprecation warnings, tra...
cleanups (scaladoc 2, deprecation warnings, trailing blanks)
Diffstat (limited to 'src/manual')
-rw-r--r-- | src/manual/scala/tools/docutil/EmitHtml.scala | 156 | ||||
-rw-r--r-- | src/manual/scala/tools/docutil/EmitManPage.scala | 82 | ||||
-rw-r--r-- | src/manual/scala/tools/docutil/ManMaker.scala | 12 | ||||
-rw-r--r-- | src/manual/scala/tools/docutil/resources/css/style.css | 15 | ||||
-rw-r--r-- | src/manual/scala/tools/docutil/resources/index.html | 16 |
5 files changed, 150 insertions, 131 deletions
diff --git a/src/manual/scala/tools/docutil/EmitHtml.scala b/src/manual/scala/tools/docutil/EmitHtml.scala index 394e32cb4b..ddfb8cb0f2 100644 --- a/src/manual/scala/tools/docutil/EmitHtml.scala +++ b/src/manual/scala/tools/docutil/EmitHtml.scala @@ -20,110 +20,110 @@ object EmitHtml { /* */ def emitSection(section: Section, depth: Int) { def emitPara(text: AbstractText) { - out.println("<div>") + out println "<div>" emitText(text) - out.println("\n</div>") + out println "\n</div>" } def emitText(text: AbstractText) { text match { case seq:SeqText => - seq.components.foreach(emitText) + seq.components foreach emitText case seq:SeqPara => - seq.components.foreach(emitPara) + seq.components foreach emitPara case Text(text) => - out.print(escape(text)) + out print escape(text) case BSlash => - out.print("\\") + out print "\\" case MDash => - out.print("—") + out print "—" case NDash => - out.print("–") + out print "–" case Bold(text) => - out.print("<b>") + out print "<b>" emitText(text) - out.print("</b>") + out print "</b>" case Italic(text) => - out.print("<i>") + out print "<i>" emitText(text) - out.print("</i>") + out print "</i>" case Emph(text) => - out.print("<em>") + out print "<em>" emitText(text) - out.print("</em>") + out print "</em>" case Mono(text) => - out.print("<code>") + out print "<code>" emitText(text) - out.print("</code>") + out print "</code>" case Quote(text) => - out.print("\"") + out print "\"" emitText(text) - out.print("\"") + out print "\"" case DefinitionList(definitions @ _*) => - out.println("<ins><dl>") + out println "<ins><dl>" for (d <- definitions) { - out.println("<dt>") + out println "<dt>" emitText(d.term) - out.println("\n</dt>") - out.println("<dd>") + out println "\n</dt>" + out println "<dd>" emitText(d.description) - out.println("</dd>") + out println "</dd>" } - out.println("</dl></ins>") + out println "</dl></ins>" case Link(label, url) => out.print("<a href=\"" + url + "\">") emitText(label) - out.print("</a>") + out print "</a>" case _ => - error("unknown text node: " + text) + sys.error("unknown text node: " + text) } } def emitParagraph(para: Paragraph) { para match { case TextParagraph(text) => - out.println("<p>") + out println "<p>" emitText(text) - out.println("</p>") + out println "</p>" case BlockQuote(text) => - out.println("<blockquote><p>") + out println "<blockquote><p>" emitText(text) - out.println("</p></blockquote>") + out println "</p></blockquote>" case CodeSample(text) => - out.print("<pre>") - out.print(escape(text)) - out.println("</pre>") + out print "<pre>" + out print escape(text) + out println "</pre>" case lst:BulletList => - out.println("<ul>") + out println "<ul>" for (item <- lst.items) { - out.print("<li>") + out print "<li>" emitText(item) - out.println("</li>") + out println "</li>" } - out.println("</ul>") + out println "</ul>" case lst:NumberedList => - out.println("<ol>") + out println "<ol>" for (item <- lst.items) { - out.print("<li>") + out print "<li>" emitText(item) } - out.println("</ol>") + out println "</ol>" case TitledPara(title, text) => out.println("<p><strong>" + escape(title) + "</strong></p>") @@ -133,7 +133,7 @@ object EmitHtml { emitSection(sect, depth + 1) case _ => - error("unknown paragraph node: " + para) + sys.error("unknown paragraph node: " + para) } } @@ -141,33 +141,33 @@ object EmitHtml { out.println("\n<h" + depth + " id=\"" + name + "\">" + section.title + "</h" + depth + ">") - section.paragraphs.foreach(emitParagraph) + section.paragraphs foreach emitParagraph } private def emit3columns(col1: String, col2: String, col3: String) { - out.println("<div style=\"float:left;\">") - out.println(col1) - out.println("</div>") - out.println("<div style=\"float:right;\">") - out.println(col3) - out.println("</div>") - out.println("<div style=\"text-align:center;\">") - out.println(col2) - out.println("</div>") + out println "<div style=\"float:left;\">" + out println col1 + out println "</div>" + out println "<div style=\"float:right;\">" + out println col3 + out println "</div>" + out println "<div style=\"text-align:center;\">" + out println col2 + out println "</div>" } private def emitHeader(col1: String, col2: String, col3: String) { - out.println("<!-- header -->") - out.println("<div style=\"margin: 0 0 2em 0;\">") + out println "<!-- header -->" + out println "<div style=\"margin: 0 0 2em 0;\">" emit3columns(col1, col2, col3) - out.println("</div>") + out println "</div>" } private def emitFooter(col1: String, col2: String, col3: String) { - out.println("<!-- footer -->") - out.println("<div style=\"margin: 2em 0 0 0;\">") + out println "<!-- footer -->" + out println "<div style=\"margin: 2em 0 0 0;\">" emit3columns(col1, col2, col3) - out.println("</div>") + out println "</div>" } def emitDocument(document: Document) { @@ -175,31 +175,31 @@ object EmitHtml { out.println("<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.1//EN\" \"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd\">") out.println("<html xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"en\" lang=\"en\">\n") - out.println("<head>") + out println "<head>" out.println("<title>" + document.title + " man page</title>") out.println("<meta http-equiv=\"Content-Language\" content=\"en\"/>") out.println("<meta http-equiv=\"Content-Type\" content=\"text/html; charset=" + document.encoding + "\"/>") out.println("<meta name=\"Author\" content=\"" + document.author + "\"/>") - out.println("<style type=\"text/css\">") - out.println(" <!--") - out.println(" blockquote, pre { margin:1em 4em 1em 4em; }") - out.println(" dt { margin: 0.6em 0 0 0; }") - out.println(" p { margin:0.6em 2em 0.6em 2em; text-align:justify; }") - out.println(" //-->") - out.println("</style>") - out.println("</head>\n") - - out.println("<body>") + out println "<style type=\"text/css\">" + out println " <!--" + out println " blockquote, pre { margin:1em 4em 1em 4em; }" + out println " dt { margin: 0.6em 0 0 0; }" + out println " p { margin:0.6em 2em 0.6em 2em; text-align:justify; }" + out println " //-->" + out println "</style>" + out println "</head>\n" + + out println "<body>" val name = document.title + "(" + document.category.id + ")" emitHeader(name, "" + document.category, name) - document.sections.foreach(s => emitSection(s, 3)) + document.sections foreach (s => emitSection(s, 3)) emitFooter("version " + document.version, document.date, name) - out.println("</body>") - out.println("</html>") + out println "</body>" + out println "</html>" } /* */ /* @@ -340,25 +340,25 @@ object EmitHtml { */ def main(args: Array[String]) { if (args.length < 1) { - System.err.println("usage: EmitHtml <classname>") - exit(1) + System.err println "usage: EmitHtml <classname>" + sys.exit(1) } try { val cl = this.getClass.getClassLoader() - val clasz = cl.loadClass(args(0)) - val meth = clasz.getDeclaredMethod("manpage") + val clasz = cl loadClass args(0) + val meth = clasz getDeclaredMethod "manpage" val doc = meth.invoke(null).asInstanceOf[Document] emitDocument(doc) } catch { case ex: Exception => ex.printStackTrace() - System.err.println("Error in EmitHtml") - exit(1) + System.err println "Error in EmitHtml" + sys.exit(1) } } def emitHtml(classname: String, outStream: java.io.OutputStream) { - out.setOut(outStream) + out setOut outStream main(Array(classname)) } } diff --git a/src/manual/scala/tools/docutil/EmitManPage.scala b/src/manual/scala/tools/docutil/EmitManPage.scala index bab685274b..4a66e2ed07 100644 --- a/src/manual/scala/tools/docutil/EmitManPage.scala +++ b/src/manual/scala/tools/docutil/EmitManPage.scala @@ -21,34 +21,34 @@ object EmitManPage { def emitSection(section: Section, depth: Int) { def emitPara(text: AbstractText) { emitText(text) - out.println("\n.IP") + out println "\n.IP" } def emitText(text: AbstractText) { text match { case seq:SeqText => - seq.components.foreach(emitText) + seq.components foreach emitText case seq:SeqPara => - seq.components.foreach(emitPara) + seq.components foreach emitPara case Text(text) => - out.print(escape(text)) + out print escape(text) case BSlash => - out.print("\\e") + out print "\\e" case NDash | MDash => - out.print("\\-") + out print "\\-" case Bold(text) => - out.print("\\fB") + out print "\\fB" emitText(text) - out.print("\\fR") + out print "\\fR" case Italic(text) => - out.print("\\fI") + out print "\\fI" emitText(text) - out.print("\\fR") + out print "\\fR" case Emph(text) => out.print("\\fI") @@ -68,7 +68,7 @@ object EmitManPage { case DefinitionList(definitions @ _*) => var n = definitions.length for (d <- definitions) { - out.println(".TP") + out println ".TP" emitText(d.term) out.println emitText(d.description) @@ -79,30 +79,30 @@ object EmitManPage { emitText(label) case _ => - error("unknown text node: " + text) + sys.error("unknown text node: " + text) } } def emitParagraph(para: Paragraph) { para match { case TextParagraph(text) => - out.println(".PP") + out println ".PP" emitText(text) out.println case BlockQuote(text) => - out.println(".TP") + out println ".TP" emitText(text) out.println case CodeSample(text) => - out.println("\n.nf") + out println "\n.nf" out.print(text) - out.println("\n.fi") + out println "\n.fi" case lst:BulletList => for (item <- lst.items) { - out.println(".IP") + out println ".IP" emitText(item) out.println } @@ -118,68 +118,68 @@ object EmitManPage { } case TitledPara(title, text) => - out.println(".PP") - out.print("\\fB") + out println ".PP" + out print "\\fB" emitText(title) - out.print("\\fR") + out print "\\fR" emitText(text) case EmbeddedSection(sect) => emitSection(sect, depth + 1) case _ => - error("unknown paragraph node: " + para) + sys.error("unknown paragraph node: " + para) } } - out.println(".\\\"") + out println ".\\\"" out.println(".\\\" ############################## " + section.title + " ###############################") - out.println(".\\\"") + out println ".\\\"" val tag = if (depth > 1) ".SS" else ".SH" val title = if (section.title.indexOf(" ") > 0) "\"" + section.title + "\"" else section.title out.println(tag + " " + title) - section.paragraphs.foreach(emitParagraph) + section.paragraphs foreach emitParagraph } def emitDocument(doc: Document) { - out.println(".\\\" ##########################################################################") - out.println(".\\\" # __ #") - out.println(".\\\" # ________ ___ / / ___ Scala 2 On-line Manual Pages #") - out.println(".\\\" # / __/ __// _ | / / / _ | (c) 2002-2011, LAMP/EPFL #") - out.println(".\\\" # __\\ \\/ /__/ __ |/ /__/ __ | #") - out.println(".\\\" # /____/\\___/_/ |_/____/_/ | | http://scala-lang.org/ #") - out.println(".\\\" # |/ #") - out.println(".\\\" ##########################################################################") - out.println(".\\\"") - out.println(".\\\" Process this file with nroff -man scala.1") - out.println(".\\\"") + out println ".\\\" ##########################################################################" + out println ".\\\" # __ #" + out println ".\\\" # ________ ___ / / ___ Scala 2 On-line Manual Pages #" + out println ".\\\" # / __/ __// _ | / / / _ | (c) 2002-2011, LAMP/EPFL #" + out println ".\\\" # __\\ \\/ /__/ __ |/ /__/ __ | #" + out println ".\\\" # /____/\\___/_/ |_/____/_/ | | http://scala-lang.org/ #" + out println ".\\\" # |/ #" + out println ".\\\" ##########################################################################" + out println ".\\\"" + out println ".\\\" Process this file with nroff -man scala.1" + out println ".\\\"" out.println(".TH " + doc.title + " " + doc.category.id + " \"" + doc.date + "\" \"version " + doc.version + "\" \"" + doc.category + "\"") - doc.sections.foreach(s => emitSection(s, 1)) + doc.sections foreach (s => emitSection(s, 1)) } def main(args: Array[String]) { try { val cl = this.getClass.getClassLoader() - val clasz = cl.loadClass(args(0)) - val meth = clasz.getDeclaredMethod("manpage") + val clasz = cl loadClass args(0) + val meth = clasz getDeclaredMethod "manpage" val doc = meth.invoke(null).asInstanceOf[Document] emitDocument(doc) } catch { case ex: Exception => ex.printStackTrace() - System.err.println("Error in EmitManPage") - exit(1) + System.err println "Error in EmitManPage" + sys.exit(1) } } def emitManPage(classname: String, outStream: java.io.OutputStream) { - out.setOut(outStream) + out setOut outStream main(Array(classname)) } } diff --git a/src/manual/scala/tools/docutil/ManMaker.scala b/src/manual/scala/tools/docutil/ManMaker.scala index b947e3dce4..fa35e658dd 100644 --- a/src/manual/scala/tools/docutil/ManMaker.scala +++ b/src/manual/scala/tools/docutil/ManMaker.scala @@ -1,3 +1,9 @@ +/* NSC -- new Scala compiler + * Copyright 2005-2011 LAMP/EPFL + * @author Stephane Micheloud + * Adapted from Lex Spoon's sbaz manual + */ + package scala.tools.docutil import org.apache.tools.ant.Task @@ -32,9 +38,9 @@ class ManMaker extends Task { } override def execute() { - if (command.isEmpty) error("Attribute 'command' is not set.") - if (htmlout.isEmpty) error("Attribute 'htmlout' is not set.") - if (manout.isEmpty) error("Attribute 'manout' is not set.") + if (command.isEmpty) sys.error("Attribute 'command' is not set.") + if (htmlout.isEmpty) sys.error("Attribute 'htmlout' is not set.") + if (manout.isEmpty) sys.error("Attribute 'manout' is not set.") command foreach (cmd => { val classname = "scala.man1."+ cmd diff --git a/src/manual/scala/tools/docutil/resources/css/style.css b/src/manual/scala/tools/docutil/resources/css/style.css index 3072be4012..62768298cb 100644 --- a/src/manual/scala/tools/docutil/resources/css/style.css +++ b/src/manual/scala/tools/docutil/resources/css/style.css @@ -61,6 +61,19 @@ span.tool { font-weight: bold; } -th { +table.basic { + width: 100%; +} + +table.basic td { + margin: 0; + padding: 2px; +} + +table.basic th { + text-align: left; +} + +table.basic th.links, td.links { white-space: nowrap; } diff --git a/src/manual/scala/tools/docutil/resources/index.html b/src/manual/scala/tools/docutil/resources/index.html index 67913e7aac..4e5130aa3d 100644 --- a/src/manual/scala/tools/docutil/resources/index.html +++ b/src/manual/scala/tools/docutil/resources/index.html @@ -114,11 +114,11 @@ use to create and build applications. </p> -<table cellspacing="0" cellpadding="2" style="width:100%;"> +<table class="basic"> <tr> <th>Tool Name</th> <th>Brief Description</th> - <th>Links to Reference Pages</th> + <th class="links">Links to Reference Pages</th> </tr> <tr> <td width="13%" valign="top"> @@ -127,7 +127,7 @@ <td width="70%" valign="top"> The fast Scala compiler. </td> - <td width="17%" valign="top"> + <td width="17%" valign="top" class="links"> [<a href="fsc.html">Solaris, Linux and Windows</a>] </td> </tr> @@ -138,7 +138,7 @@ <td width="70%" valign="top"> The Scala sharing tool. </td> - <td width="17%" valign="top"> + <td width="17%" valign="top" class="links"> [<a href="sbaz.html">Solaris, Linux and Windows</a>] </td> </tr> @@ -149,7 +149,7 @@ <td width="70%" valign="top"> Run Scala code. </td> - <td width="17%" valign="top"> + <td width="17%" valign="top" class="links"> [<a href="scala.html">Solaris, Linux and Windows</a>] </td> </tr> @@ -160,7 +160,7 @@ <td width="70%" valign="top"> Compile Scala code ahead of time. </td> - <td width="17%" valign="top"> + <td width="17%" valign="top" class="links"> [<a href="scalac.html">Solaris, Linux and Windows</a>] </td> </tr> @@ -171,7 +171,7 @@ <td width="70%" valign="top"> The API document generator. </td> - <td width="17%" valign="top"> + <td width="17%" valign="top" class="links"> [<a href="scaladoc.html">Solaris, Linux and Windows</a>] </td> </tr> @@ -182,7 +182,7 @@ <td width="70%" valign="top"> The Scala class file decoder. </td> - <td width="17%" valign="top"> + <td width="17%" valign="top" class="links"> [<a href="scalap.html">Solaris, Linux and Windows</a>] </td> </tr> |