Tastydoc

.gitignore

@@ -83,3 +83,37 @@ community-build/sbt-dotty-sbt
 
 # Vulpix output files
 *.check.out
+
+tastydoc/report/report\.aux
+
+tastydoc/report/report\.fdb_latexmk
+
+tastydoc/report/report\.fls
+
+tastydoc/report/report\.synctex\.gz
+
+tastydoc/report/report\.toc
+
+tastydoc/report/report\.out
+
+tastydoc/report/presentation/presentation\.aux
+
+tastydoc/report/presentation/presentation\.fdb_latexmk
+
+tastydoc/report/presentation/presentation\.fls
+
+tastydoc/report/presentation/presentation\.nav
+
+tastydoc/report/presentation/presentation\.out
+
+tastydoc/report/presentation/presentation\.snm
+
+tastydoc/report/presentation/presentation\.synctex\.gz
+
+tastydoc/report/presentation/presentation\.toc
+
+tastydoc/dotty-0\.15\.0-RC1/
+
+tastydoc/report/presentation/presentation\.vrb
+
+tastydoc/dotty-0\.16\.0-RC3/

build.sbt

@@ -17,6 +17,8 @@ val `dotty-bench-bootstrapped` = Build.`dotty-bench-bootstrapped`
 val `tasty-core` = Build.`tasty-core`
 val `tasty-core-bootstrapped` = Build.`tasty-core-bootstrapped`
 val `tasty-core-scala2` = Build.`tasty-core-scala2`
+val `dotty-tastydoc` = Build.`dotty-tastydoc`
+val `dotty-tastydoc-input` = Build.`dotty-tastydoc-input`
 val `scala-library` = Build.`scala-library`
 val `scala-compiler` = Build.`scala-compiler`
 val `scala-reflect` = Build.`scala-reflect`

doc-tool/src/dotty/tools/dottydoc/model/comment/Comment.scala

@@ -6,7 +6,7 @@ package comment
 import dotty.tools.dottydoc.util.syntax._
 import dotty.tools.dotc.core.Contexts.Context
 import dotty.tools.dotc.util.Spans._
-import com.vladsch.flexmark.ast.{ Node => MarkdownNode }
+import com.vladsch.flexmark.util.ast.{ Node => MarkdownNode }
 import HtmlParsers._
 import util.MemberLookup
 

doc-tool/src/dotty/tools/dottydoc/model/comment/CommentParser.scala

@@ -11,7 +11,7 @@ import dotty.tools.dotc.printing.Formatting.hl
 import scala.collection.mutable
 import dotty.tools.dotc.config.Printers.dottydoc
 import scala.util.matching.Regex
-import com.vladsch.flexmark.ast.{ Node => MarkdownNode }
+import com.vladsch.flexmark.util.ast.{ Node => MarkdownNode }
 import com.vladsch.flexmark.parser.{ Parser => MarkdownParser }
 
 trait CommentParser extends util.MemberLookup {

doc-tool/src/dotty/tools/dottydoc/model/comment/HtmlParsers.scala

@@ -8,7 +8,7 @@ import dotc.util.Spans._
 import dotty.tools.dottydoc.util.syntax._
 import util.MemberLookup
 
-import com.vladsch.flexmark.ast.{ Node => MarkdownNode }
+import com.vladsch.flexmark.util.ast.{ Node => MarkdownNode}
 import com.vladsch.flexmark.html.HtmlRenderer
 import com.vladsch.flexmark.parser.Parser
 import com.vladsch.flexmark.util.sequence.CharSubSequence
@@ -17,7 +17,9 @@ object HtmlParsers {
 
   implicit class StringToMarkdown(val text: String) extends AnyVal {
     def toMarkdown(origin: Entity)(implicit ctx: Context): MarkdownNode = {
-      import com.vladsch.flexmark.ast.{ Link, Visitor, VisitHandler, NodeVisitor }
+      import com.vladsch.flexmark.ast.Link
+      import com.vladsch.flexmark.util.ast.{Visitor, VisitHandler, NodeVisitor }
+
 
       val inlineToHtml = InlineToHtml(origin)
 
@@ -149,4 +151,4 @@ object HtmlParsers {
       }
     }
   }
-}
+}

doc-tool/src/dotty/tools/dottydoc/model/comment/MarkdownShortener.scala

@@ -10,6 +10,7 @@ package comment
   * @note calling `shorten` **will** mutate the Markdown AST node.
   */
 class MarkdownShortener {
+  import com.vladsch.flexmark.util.ast._
   import com.vladsch.flexmark.ast._
 
   def shorten(node: Node, maxLen: Int = 150): Node = {
@@ -80,4 +81,4 @@ class MarkdownShortener {
     nodeVisitor.visit(node)
     node
   }
-}
+}

doc-tool/src/dotty/tools/dottydoc/staticsite/MarkdownCodeBlockVisitor.scala

@@ -2,6 +2,7 @@ package dotty.tools
 package dottydoc
 package staticsite
 
+import com.vladsch.flexmark.util.ast._
 import com.vladsch.flexmark.ast._
 import com.vladsch.flexmark.util.sequence.CharSubSequence
 
@@ -16,4 +17,4 @@ object MarkdownCodeBlockVisitor {
       })
     )
     .visit(node)
-}
+}

doc-tool/src/dotty/tools/dottydoc/staticsite/MarkdownLinkVisitor.scala

@@ -3,6 +3,7 @@ package dottydoc
 package staticsite
 
 import com.vladsch.flexmark.ast._
+import com.vladsch.flexmark.util.ast._
 import com.vladsch.flexmark.util.sequence.{BasedSequence, CharSubSequence}
 import model.{Def, Package, TypeAlias, Val}
 import dottydoc.util.MemberLookup
@@ -42,4 +43,4 @@ object MarkdownLinkVisitor {
       })
     )
     .visit(node)
-}
+}

project/Build.scala

@@ -374,6 +374,28 @@ object Build {
     dottyLib + File.pathSeparator + findArtifactPath(externalDeps, "scala-library")
   }
 
+  lazy val tastydocSettings = Seq(
+    baseDirectory in (Compile, run) := baseDirectory.value / "..",
+    baseDirectory in Test := baseDirectory.value / "..",
+    libraryDependencies +=
+      "com.novocode" % "junit-interface" % "0.11",
+    libraryDependencies ++= {
+      val flexmarkVersion = "0.42.12"
+      Seq(
+        "com.vladsch.flexmark" % "flexmark-all" % flexmarkVersion,
+        "com.vladsch.flexmark" % "flexmark-ext-gfm-tasklist" % flexmarkVersion,
+        "com.vladsch.flexmark" % "flexmark-ext-gfm-tables" % flexmarkVersion,
+        "com.vladsch.flexmark" % "flexmark-ext-autolink" % flexmarkVersion,
+        "com.vladsch.flexmark" % "flexmark-ext-anchorlink" % flexmarkVersion,
+        "com.vladsch.flexmark" % "flexmark-ext-emoji" % flexmarkVersion,
+        "com.vladsch.flexmark" % "flexmark-ext-gfm-strikethrough" % flexmarkVersion,
+        "com.vladsch.flexmark" % "flexmark-ext-yaml-front-matter" % flexmarkVersion,
+        Dependencies.`jackson-dataformat-yaml`,
+        "nl.big-o" % "liqp" % "0.6.7"
+      )
+    }
+  )
+
   def dottyDocSettings(implicit mode: Mode) = Seq(
     baseDirectory in (Compile, run) := baseDirectory.value / "..",
     baseDirectory in Test := baseDirectory.value / "..",
@@ -414,9 +436,9 @@ object Build {
     }.evaluated,
 
     libraryDependencies ++= {
-      val flexmarkVersion = "0.28.32"
+      val flexmarkVersion = "0.42.12"
       Seq(
-        "com.vladsch.flexmark" % "flexmark" % flexmarkVersion,
+        "com.vladsch.flexmark" % "flexmark-all" % flexmarkVersion,
         "com.vladsch.flexmark" % "flexmark-ext-gfm-tasklist" % flexmarkVersion,
         "com.vladsch.flexmark" % "flexmark-ext-gfm-tables" % flexmarkVersion,
         "com.vladsch.flexmark" % "flexmark-ext-autolink" % flexmarkVersion,
@@ -1021,6 +1043,9 @@ object Build {
   lazy val `dotty-bench` = project.in(file("bench")).asDottyBench(NonBootstrapped)
   lazy val `dotty-bench-bootstrapped` = project.in(file("bench")).asDottyBench(Bootstrapped)
 
+  lazy val `dotty-tastydoc` = project.in(file("tastydoc")).asDottyTastydoc(Bootstrapped)
+  lazy val `dotty-tastydoc-input` = project.in(file("tastydoc/input")).asDottyTastydocInput(Bootstrapped)
+
   // Depend on dotty-library so that sbt projects using dotty automatically
   // depend on the dotty-library
   lazy val `scala-library` = project.
@@ -1329,6 +1354,14 @@ object Build {
       settings(commonBenchmarkSettings).
       enablePlugins(JmhPlugin)
 
+    def asDottyTastydoc(implicit mode: Mode): Project = project.withCommonSettings.
+      aggregate(`dotty-tastydoc-input`).
+      dependsOn(dottyCompiler).
+      settings(tastydocSettings)
+
+    def asDottyTastydocInput(implicit mode: Mode): Project = project.withCommonSettings.
+      dependsOn(dottyCompiler)
+
     def asDist(implicit mode: Mode): Project = project.
       enablePlugins(PackPlugin).
       withCommonSettings.

semanticdb/project/build.properties

@@ -0,0 +1 @@
+sbt.version=1.2.6

tastydoc/TODO.md

@@ -0,0 +1,14 @@
+# Comment parsing
+## Files from dotty-doc requiring work
+* util.traversing
+  * ImplicitlyAddedFrom
+  * Fix linking for inherited method
+
+# Other
+* Check remaining TODOs/TOASKs/TOFIX
+
+# Representation
+* Id for typeparams so we can link (Do not link)
+* Alias type
+* Rework type matching + Order in type matching symbol counts...
+* Remove artifacts in packages => Will fix linking as well

tastydoc/documentation/dotty/DottyPredef$.md

@@ -0,0 +1,41 @@
+dotty
+# object DottyPredef
+
+<pre><code class="language-scala" >final object DottyPredef extends Serializable</pre></code>
+## Concrete Value Members:
+### assert
+<pre><code class="language-scala" >@forceInline final def assert(assertion: => Boolean): Unit</pre></code>
+
+### assert
+<pre><code class="language-scala" >@forceInline final def assert(assertion: => Boolean, message: => Any): Unit</pre></code>
+
+### assertFail
+<pre><code class="language-scala" >def assertFail(message: => Any): Unit</pre></code>
+
+### assertFail
+<pre><code class="language-scala" >def assertFail(): Unit</pre></code>
+
+### implicitly
+<pre><code class="language-scala" >@forceInline final def implicitly[T](implicit ev: T): T</pre></code>
+
+### locally
+<pre><code class="language-scala" >@forceInline def locally[T](body: => T): T</pre></code>
+
+### the
+<pre><code class="language-scala" >inline def the[T](x: T): x</pre></code>
+
+### valueOf
+<pre><code class="language-scala" >inline def valueOf[T]: T</pre></code>
+Retrieve the single value of a type with a unique inhabitant.
+
+***Example*** 
+```scala
+object Foo
+val foo = valueOf[Foo.type]
+// foo is Foo.type = Foo
+val bar = valueOf[23]
+// bar is 23.type = 23
+```
+
+***Group*** utilities
+

tastydoc/documentation/dotty/dotty.md

@@ -0,0 +1,5 @@
+# Package dotty
+## Members:
+<pre><code class="language-scala" >final object <a href="./DottyPredef$.md">DottyPredef</a></pre></code>
+<pre><code class="language-scala" >final val DottyPredef: <a href="./DottyPredef$.md">DottyPredef</a></pre></code>
+

tastydoc/documentation/dotty/internal/StringContextMacro$.md

@@ -0,0 +1,9 @@
+dotty.internal
+# object StringContextMacro
+
+<pre><code class="language-scala" >final object StringContextMacro extends Serializable</pre></code>
+## Concrete Value Members:
+### f
+<pre><code class="language-scala" >inline def f(sc: => StringContext)(args: Seq[Any]): String</pre></code>
+Implemetation of scala.StringContext.f used in Dotty while the standard library is still not bootstrapped
+

tastydoc/documentation/dotty/internal/internal.md

@@ -0,0 +1,5 @@
+# Package internal
+## Members:
+<pre><code class="language-scala" >final object <a href="./StringContextMacro$.md">StringContextMacro</a></pre></code>
+<pre><code class="language-scala" >final val StringContextMacro: <a href="./StringContextMacro$.md">StringContextMacro</a></pre></code>
+

tastydoc/documentation/dotty/runtime/Arrays$.md

@@ -0,0 +1,21 @@
+dotty.runtime
+# object Arrays
+
+<pre><code class="language-scala" >final object Arrays extends Serializable</pre></code>
+All but the first two operations should be short-circuited and implemented specially by
+the backend.
+
+## Concrete Value Members:
+### newArray
+<pre><code class="language-scala" >def newArray[Arr](componentType: Class[Nothing <: Any], returnType: Class[Arr], dimensions: Array[Int]): Arr</pre></code>
+Create an array of a reference type T.
+
+### newGenericArray
+<pre><code class="language-scala" >def newGenericArray[T](length: Int)(implicit tag: <a href="../../scala/reflect/ClassTag.md">ClassTag</a>[T]): Array[T]</pre></code>
+Creates an array of some element type determined by the given `ClassTag`
+argument. The erased type of applications of this method is `Object`.
+
+### seqToArray
+<pre><code class="language-scala" >def seqToArray[T](xs: Seq[T], clazz: Class[Nothing <: Any]): Array[T]</pre></code>
+Convert a sequence to a Java array with element type given by `clazz`.
+

tastydoc/documentation/dotty/runtime/LazyVals$.md

@@ -0,0 +1,31 @@
+dotty.runtime
+# object LazyVals
+
+<pre><code class="language-scala" >final object LazyVals extends Serializable</pre></code>
+Helper methods used in thread-safe lazy vals.
+
+## Concrete Type Members:
+### Names
+<pre><code class="language-scala" >final object <a href="./LazyVals$/Names$.md">Names</a></pre></code>
+## Concrete Value Members:
+### CAS
+<pre><code class="language-scala" >def CAS(t: Object, offset: Long, e: Long, v: Int, ord: Int): Boolean</pre></code>
+
+### STATE
+<pre><code class="language-scala" >def STATE(cur: Long, ord: Int): Long</pre></code>
+
+### get
+<pre><code class="language-scala" >def get(t: Object, off: Long): Long</pre></code>
+
+### getOffset
+<pre><code class="language-scala" >def getOffset(clz: Class[Nothing <: Any], name: String): Long</pre></code>
+
+### setFlag
+<pre><code class="language-scala" >def setFlag(t: Object, offset: Long, v: Int, ord: Int): Unit</pre></code>
+
+### wait4Notification
+<pre><code class="language-scala" >def wait4Notification(t: Object, offset: Long, cur: Long, ord: Int): Unit</pre></code>
+
+### BITS_PER_LAZY_VAL
+<pre><code class="language-scala" >final inline val BITS_PER_LAZY_VAL: 2</pre></code>
+

tastydoc/documentation/dotty/runtime/LazyVals$/Names$.md

@@ -0,0 +1,23 @@
+dotty.runtime.LazyVals$
+# object Names
+
+<pre><code class="language-scala" >final object Names extends Serializable</pre></code>
+## Concrete Value Members:
+### cas
+<pre><code class="language-scala" >final inline val cas: CAS</pre></code>
+
+### get
+<pre><code class="language-scala" >final inline val get: get</pre></code>
+
+### getOffset
+<pre><code class="language-scala" >final inline val getOffset: getOffset</pre></code>
+
+### setFlag
+<pre><code class="language-scala" >final inline val setFlag: setFlag</pre></code>
+
+### state
+<pre><code class="language-scala" >final inline val state: STATE</pre></code>
+
+### wait4Notification
+<pre><code class="language-scala" >final inline val wait4Notification: wait4Notification</pre></code>
+

tastydoc/documentation/dotty/runtime/LegacyApp.md

@@ -0,0 +1,11 @@
+dotty.runtime
+# class LegacyApp
+
+<pre><code class="language-scala" >class LegacyApp</pre></code>
+Replaces the `scala.App` class which relies on `DelayedInit` functionality,
+not supported by Dotty.
+
+## Concrete Value Members:
+### main
+<pre><code class="language-scala" >def main(args: Array[String]): Unit</pre></code>
+

tastydoc/documentation/dotty/runtime/runtime.md

@@ -0,0 +1,22 @@
+# Package runtime
+## Members:
+<pre><code class="language-scala" >final object <a href="./Arrays$.md">Arrays</a></pre></code>
+All but the first two operations should be short-circuited and implemented specially by
+the backend.
+
+<pre><code class="language-scala" >final val Arrays: <a href="./Arrays$.md">Arrays</a></pre></code>
+All but the first two operations should be short-circuited and implemented specially by
+the backend.
+
+
+<pre><code class="language-scala" >final object <a href="./LazyVals$.md">LazyVals</a></pre></code>
+Helper methods used in thread-safe lazy vals.
+
+<pre><code class="language-scala" >final val LazyVals: <a href="./LazyVals$.md">LazyVals</a></pre></code>
+Helper methods used in thread-safe lazy vals.
+
+
+<pre><code class="language-scala" >class <a href="./LegacyApp.md">LegacyApp</a></pre></code>
+Replaces the `scala.App` class which relies on `DelayedInit` functionality,
+not supported by Dotty.
+