Javadoc: make parsing of java comments optional

Author: jodersky

src/scaladoc/scala/tools/nsc/doc/ScaladocGlobal.scala

@@ -13,7 +13,11 @@ trait ScaladocGlobalTrait extends Global {
 
   override val useOffsetPositions = false
   override def newUnitParser(unit: CompilationUnit) = new syntaxAnalyzer.ScaladocUnitParser(unit, Nil)
-  override def newJavaUnitParser(unit: CompilationUnit) = new syntaxAnalyzer.ScaladocJavaUnitParser(unit)
+  override def newJavaUnitParser(unit: CompilationUnit) = if (createJavadoc) {
+    new syntaxAnalyzer.ScaladocJavaUnitParser(unit)
+  } else {
+    super.newJavaUnitParser(unit)
+  }
 
   override lazy val syntaxAnalyzer = new ScaladocSyntaxAnalyzer[outer.type](outer) {
     val runsAfter = List[String]()
@@ -41,7 +45,7 @@ class ScaladocGlobal(settings: doc.Settings, reporter: Reporter) extends Global(
     phasesSet += analyzer.typerFactory
   }
   override def forScaladoc = true
-  override def createJavadoc = true
+  override def createJavadoc = if (settings.docNoJavaComments.value) false else true
 
   override lazy val analyzer = new {
     val global: ScaladocGlobal.this.type = ScaladocGlobal.this

src/scaladoc/scala/tools/nsc/doc/Settings.scala

@@ -213,6 +213,11 @@ class Settings(error: String => Unit, val printMsg: String => Unit = println(_))
     "Group similar functions together (based on the @group annotation)"
   )
 
+  val docNoJavaComments = BooleanSetting (
+    "-no-java-comments",
+    "Prevents parsing and inclusion of comments from java sources."
+  )
+
   // For improved help output.
   def scaladocSpecific = Set[Settings#Setting](
     docformat, doctitle, docfooter, docversion, docUncompilable, docsourceurl, docgenerator, docRootContent, useStupidTypes,
@@ -222,7 +227,7 @@ class Settings(error: String => Unit, val printMsg: String => Unit = println(_))
     docImplicits, docImplicitsDebug, docImplicitsShowAll, docImplicitsHide, docImplicitsSoundShadowing,
     docDiagramsMaxNormalClasses, docDiagramsMaxImplicitClasses,
     docNoPrefixes, docNoLinkWarnings, docRawOutput, docSkipPackages,
-    docExpandAllTypes, docGroups
+    docExpandAllTypes, docGroups, docNoJavaComments
   )
   val isScaladocSpecific: String => Boolean = scaladocSpecific map (_.name)
 

src/scaladoc/scala/tools/partest/ScaladocJavaModelTest.scala

@@ -0,0 +1,15 @@
+package scala.tools.partest
+
+import scala.tools.nsc.doc.Universe
+
+/** A class for testing scaladoc model generation on java sources. */
+abstract class ScaladocJavaModelTest extends ScaladocModelTest {
+
+  // overridden to pass explicit files to newDocFactory.makeUniverse (rather than code strings)
+  // since the .java file extension is required
+  override def model: Option[Universe] = {
+    val path = resourcePath + "/" + resourceFile
+    newDocFactory.makeUniverse(Left(List(path)))
+  }
+
+}

test/scaladoc/run/SI-4826-no-comments.check

@@ -0,0 +1 @@
+Done.

test/scaladoc/run/SI-4826-no-comments.scala

@@ -0,0 +1,20 @@
+import scala.tools.nsc.doc.Universe
+import scala.tools.nsc.doc.model._
+import scala.tools.partest.ScaladocJavaModelTest
+
+object Test extends ScaladocJavaModelTest {
+
+  override def resourceFile = "SI-4826.java"
+  override def scaladocSettings = "-no-java-comments"
+
+  def testModel(rootPackage: Package) = {
+    import access._
+
+    val base = rootPackage._package("test")._package("scaladoc")
+    val clazz = base._class("JavaComments")
+    val method = clazz._method("answer")
+
+    assert(clazz.comment == None)
+    assert(method.comment == None)
+  }
+}

test/scaladoc/run/SI-4826.scala

@@ -1,19 +1,10 @@
 import scala.tools.nsc.doc.Universe
 import scala.tools.nsc.doc.model._
-import scala.tools.partest.ScaladocModelTest
+import scala.tools.partest.ScaladocJavaModelTest
 
-object Test extends ScaladocModelTest {
+object Test extends ScaladocJavaModelTest {
 
   override def resourceFile = "SI-4826.java"
-
-  // overridden to pass explicit files to newDocFactory.makeUniverse (rather than code strings)
-  // since the .java file extension is required
-  override def model: Option[Universe] = {
-    val path = resourcePath + "/" + resourceFile
-    newDocFactory.makeUniverse(Left(List(path)))
-  }
-
-  // no need for special settings
   override def scaladocSettings = ""
 
   def testModel(rootPackage: Package) = {