Adds ability to document root package, as well ...

Adds ability to document root package, as well the first cut of an
introduction to the API. Contributed by Iain McGinniss during the
September doc spree.

1 files changed, 15 insertions, 0 deletions

diff --git a/src/compiler/scala/tools/ant/Scaladoc.scala b/src/compiler/scala/tools/ant/Scaladoc.scala
index a4593b8f88..253d1dec5d 100644
--- a/src/compiler/scala/tools/ant/Scaladoc.scala
+++ b/src/compiler/scala/tools/ant/Scaladoc.scala
@@ -42,6 +42,7 @@ import scala.tools.nsc.reporters.{Reporter, ConsoleReporter}
  *  - `addparams`,
  *  - `deprecation`,
  *  - `docgenerator`,
+ *  - `docrootcontent`,
  *  - `unchecked`.
  *
  *  It also takes the following parameters as nested elements:
@@ -95,6 +96,9 @@ class Scaladoc extends ScalaMatchingTask {
   /** The fully qualified name of a doclet class, which will be used to generate the documentation. */
   private var docgenerator: Option[String] = None
 
+  /** The file from which the documentation content of the root package will be taken */
+  private var docrootcontent: Option[File] = None
+
   /** The document title of the generated HTML documentation. */
   private var doctitle: Option[String] = None
 
@@ -273,6 +277,16 @@ class Scaladoc extends ScalaMatchingTask {
     docgenerator = Some(input)
   }
 
+  /**
+   * Sets the `docrootcontent` attribute.
+   *
+   * @param input The file from which the documentation content of the root
+   * package will be taken.
+   */
+  def setDocrootcontent(input : File) {
+    docrootcontent = Some(input)
+  }
+
   /** Sets the `docversion` attribute.
    *
    *  @param input The value of `docversion`.
@@ -532,6 +546,7 @@ class Scaladoc extends ScalaMatchingTask {
     docSettings.deprecation.value = deprecation
     docSettings.unchecked.value = unchecked
     if (!docgenerator.isEmpty) docSettings.docgenerator.value = docgenerator.get
+    if (!docrootcontent.isEmpty) docSettings.docRootContent.value = docrootcontent.get.getAbsolutePath()
     log("Scaladoc params = '" + addParams + "'", Project.MSG_DEBUG)
 
     docSettings processArgumentString addParams