Scaladoc 2.

1 files changed, 58 insertions, 0 deletions

diff --git a/src/compiler/scala/tools/nsc/doc/model/comment/Comment.scala b/src/compiler/scala/tools/nsc/doc/model/comment/Comment.scala
new file mode 100644
index 0000000000..e30b38a8bc
--- /dev/null
+++ b/src/compiler/scala/tools/nsc/doc/model/comment/Comment.scala
@@ -0,0 +1,58 @@
+/* NSC -- new Scala compiler -- Copyright 2007-2009 LAMP/EPFL */
+
+package scala.tools.nsc
+package doc
+package model
+package comment
+
+import scala.collection._
+
+/** A Scaladoc comment and all its tags.
+  *
+  * '''Note:''' the only instantiation site of this class is in `Parser`.
+  *
+  * @author Gilles Dubochet
+  * @author Manohar Jonnalagedda */
+abstract class Comment {
+
+  /** */
+  def body: Body
+  /* author|deprecated|param|return|see|since|throws|version|todo|tparam */
+
+  /** */
+  def authors: List[Body]
+
+  /** */
+  def see: List[Body]
+
+  /** */
+  def result: Option[Body]
+
+  /** */
+  def throws: Map[String, Body]
+
+  /** */
+  def valueParams: Map[String, Body]
+
+  /** */
+  def typeParams: Map[String, Body]
+
+  /** */
+  def version: Option[Body]
+
+  /** */
+  def since: Option[Body]
+
+  /** */
+  def todo: List[Body]
+
+  /** */
+  def deprecated: Option[Body]
+
+  override def toString =
+    body.toString + "\n" +
+    (authors map ("@author " + _.toString)).mkString("\n") +
+    (result map ("@return " + _.toString)).mkString
+
+}
+