summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVlad Ureche <vlad.ureche@gmail.com>2012-02-05 19:32:52 +0100
committerVlad Ureche <vlad.ureche@gmail.com>2012-02-05 19:32:52 +0100
commite34098b7f6e37420198fa5c7c2820d0443b46cc4 (patch)
treec7abe3a009501795dc83664473ba5ef2fdc471ae
parent4bbfed3f8fda69624ea6a96de52ba973f55900cf (diff)
downloadscala-e34098b7f6e37420198fa5c7c2820d0443b46cc4.tar.gz
scala-e34098b7f6e37420198fa5c7c2820d0443b46cc4.tar.bz2
scala-e34098b7f6e37420198fa5c7c2820d0443b46cc4.zip
Added a rootdoc page for the compiler API scaladoc
-rw-r--r--build.xml5
-rw-r--r--src/compiler/rootdoc.txt6
-rw-r--r--src/compiler/scala/tools/nsc/doc/html/HtmlFactory.scala4
-rw-r--r--src/library/rootdoc.txt (renamed from src/compiler/scala/tools/nsc/doc/html/resource/lib/rootdoc.txt)0
4 files changed, 10 insertions, 5 deletions
diff --git a/build.xml b/build.xml
index 57d2eed1c0..e65b66219b 100644
--- a/build.xml
+++ b/build.xml
@@ -1530,7 +1530,7 @@ DOCUMENTATION
docUncompilable="${src.dir}/library-aux"
sourcepath="${src.dir}"
classpathref="pack.classpath"
- docRootContent="${build-docs.dir}/library/lib/rootdoc.txt">
+ docRootContent="${src.dir}/library/rootdoc.txt">
<src>
<files includes="${src.dir}/actors"/>
<files includes="${src.dir}/library/scala"/>
@@ -1613,7 +1613,8 @@ DOCUMENTATION
docsourceurl="https://lampsvn.epfl.ch/trac/scala/browser/scala/trunk/src/€{FILE_PATH}.scala#L1"
sourcepath="${src.dir}"
classpathref="pack.classpath"
- srcdir="${src.dir}/compiler">
+ srcdir="${src.dir}/compiler"
+ docRootContent="${src.dir}/compiler/rootdoc.txt">
<include name="**/*.scala"/>
</scaladoc>
<touch file="${build-docs.dir}/compiler.complete" verbose="no"/>
diff --git a/src/compiler/rootdoc.txt b/src/compiler/rootdoc.txt
new file mode 100644
index 0000000000..173f604098
--- /dev/null
+++ b/src/compiler/rootdoc.txt
@@ -0,0 +1,6 @@
+The Scala compiler API.
+
+The following resources are useful for Scala plugin/compiler development:
+ - [[http://www.scala-lang.org/node/215 Scala development tutorials]] on [[http://www.scala-lang.org www.scala-lang.org]]
+ - [[https://wiki.scala-lang.org/display/SIW/ Scala Internals wiki]]
+ - [[http://lampwww.epfl.ch/~magarcia/ScalaCompilerCornerReloaded/ Scala compiler corner]], maintained by Miguel
diff --git a/src/compiler/scala/tools/nsc/doc/html/HtmlFactory.scala b/src/compiler/scala/tools/nsc/doc/html/HtmlFactory.scala
index c21507ef45..4f05678d85 100644
--- a/src/compiler/scala/tools/nsc/doc/html/HtmlFactory.scala
+++ b/src/compiler/scala/tools/nsc/doc/html/HtmlFactory.scala
@@ -80,9 +80,7 @@ class HtmlFactory(val universe: doc.Universe, index: doc.Index) {
"selected.png",
"selected2-right.png",
"selected2.png",
- "unselected.png",
-
- "rootdoc.txt"
+ "unselected.png"
)
/** Generates the Scaladoc site for a model into the site root.
diff --git a/src/compiler/scala/tools/nsc/doc/html/resource/lib/rootdoc.txt b/src/library/rootdoc.txt
index 6145429f1e..6145429f1e 100644
--- a/src/compiler/scala/tools/nsc/doc/html/resource/lib/rootdoc.txt
+++ b/src/library/rootdoc.txt