Scaladoc: Groups

Group class members based on their semantic relationship. To do this:
 - @group on members, only need to do it for the non-overridden members
 - -groups flag passes to scaladoc, groups="on" in ant
 - @groupdesc Group Group Description to add descriptions
 - @groupname Group New name for group
 - @groupprio Group <int> (lower is better)
See test/scaladoc/run/groups.scala for a top-to-bottom example

1 files changed, 8 insertions, 0 deletions

diff --git a/src/compiler/scala/tools/ant/Scaladoc.scala b/src/compiler/scala/tools/ant/Scaladoc.scala
index 03cb770474..6201501a71 100644
--- a/src/compiler/scala/tools/ant/Scaladoc.scala
+++ b/src/compiler/scala/tools/ant/Scaladoc.scala
@@ -156,6 +156,9 @@ class Scaladoc extends ScalaMatchingTask {
   /** Instruct the scaladoc not to generate prefixes */
   private var docNoPrefixes: Boolean = false
 
+  /** Instruct the scaladoc tool to group similar functions together */
+  private var docGroups: Boolean = false
+
 /*============================================================================*\
 **                             Properties setters                             **
 \*============================================================================*/
@@ -435,6 +438,10 @@ class Scaladoc extends ScalaMatchingTask {
   def setNoPrefixes(input: String) =
     docNoPrefixes = Flag.getBooleanValue(input, "noPrefixes")
 
+  /** Instruct the scaladoc tool to group similar functions together */
+  def setGroups(input: String) =
+    docGroups = Flag.getBooleanValue(input, "groups")
+
 /*============================================================================*\
 **                             Properties getters                             **
 \*============================================================================*/
@@ -634,6 +641,7 @@ class Scaladoc extends ScalaMatchingTask {
     docSettings.docDiagramsDebug.value = docDiagramsDebug
     docSettings.docRawOutput.value = docRawOutput
     docSettings.docNoPrefixes.value = docNoPrefixes
+    docSettings.docGroups.value = docGroups
     if(!docDiagramsDotPath.isEmpty) docSettings.docDiagramsDotPath.value = docDiagramsDotPath.get
 
     if (!docgenerator.isEmpty) docSettings.docgenerator.value = docgenerator.get