diff options
author | Eugene Burmako <xeno.by@gmail.com> | 2012-08-15 15:29:54 +0200 |
---|---|---|
committer | Eugene Burmako <xeno.by@gmail.com> | 2012-08-15 15:30:42 +0200 |
commit | ce90a46a6964e524933ffe193ac38d58d3df07be (patch) | |
tree | f444e94a590a340d44915951aeee996a7a5703f6 /src/compiler/scala/tools/ant/Scaladoc.scala | |
parent | d66c7a4fea537d142e42da91bfe87f4aaecc1821 (diff) | |
download | scala-ce90a46a6964e524933ffe193ac38d58d3df07be.tar.gz scala-ce90a46a6964e524933ffe193ac38d58d3df07be.tar.bz2 scala-ce90a46a6964e524933ffe193ac38d58d3df07be.zip |
adds the `skipPackage` attribute to Scaladoc
Present in http://www.slideshare.net/VladUreche/scaladoc-reflection
but not actually implemented in the ant task. Seems to be overlooked.
Diffstat (limited to 'src/compiler/scala/tools/ant/Scaladoc.scala')
-rw-r--r-- | src/compiler/scala/tools/ant/Scaladoc.scala | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/src/compiler/scala/tools/ant/Scaladoc.scala b/src/compiler/scala/tools/ant/Scaladoc.scala index b96ac6f29b..b2c6441222 100644 --- a/src/compiler/scala/tools/ant/Scaladoc.scala +++ b/src/compiler/scala/tools/ant/Scaladoc.scala @@ -44,7 +44,8 @@ import scala.tools.nsc.reporters.{Reporter, ConsoleReporter} * - `docgenerator`, * - `docrootcontent`, * - `unchecked`, - * - `nofail`. + * - `nofail`, + * - `skipPackages`. * * It also takes the following parameters as nested elements: * - `src` (for srcdir), @@ -159,6 +160,9 @@ class Scaladoc extends ScalaMatchingTask { /** Instruct the scaladoc tool to group similar functions together */ private var docGroups: Boolean = false + /** Instruct the scaladoc tool to skip certain packages */ + private var docSkipPackages: String = "" + /*============================================================================*\ ** Properties setters ** \*============================================================================*/ @@ -442,6 +446,12 @@ class Scaladoc extends ScalaMatchingTask { def setGroups(input: String) = docGroups = Flag.getBooleanValue(input, "groups") + /** Instruct the scaladoc tool to skip certain packages. + * @param input A colon-delimited list of fully qualified package names that will be skipped from scaladoc. + */ + def setSkipPackages(input: String) = + docSkipPackages = input + /*============================================================================*\ ** Properties getters ** \*============================================================================*/ @@ -642,6 +652,7 @@ class Scaladoc extends ScalaMatchingTask { docSettings.docRawOutput.value = docRawOutput docSettings.docNoPrefixes.value = docNoPrefixes docSettings.docGroups.value = docGroups + docSettings.docSkipPackages.value = docSkipPackages if(!docDiagramsDotPath.isEmpty) docSettings.docDiagramsDotPath.value = docDiagramsDotPath.get if (!docgenerator.isEmpty) docSettings.docgenerator.value = docgenerator.get |