Dotty 0.16.0-RC3 doc

Author: BryanAbate

project/Build.scala

@@ -357,7 +357,7 @@ object Build {
     libraryDependencies +=
       "com.novocode" % "junit-interface" % "0.11",
     libraryDependencies ++= {
-      val flexmarkVersion = "0.40.24"
+      val flexmarkVersion = "0.42.12"
       Seq(
         "com.vladsch.flexmark" % "flexmark-all" % flexmarkVersion,
         "com.vladsch.flexmark" % "flexmark-ext-gfm-tasklist" % flexmarkVersion,

tastydoc/documentation/example/level2/Documentation/IAmACaseObject$.md

@@ -1,7 +1,7 @@
 example.level2.Documentation
 # case object IAmACaseObject
 
-<pre><code class="language-scala" >final case object IAmACaseObject extends <a href="./CaseImplementThis.md">CaseImplementThis</a> with Product with Serializable</pre></code>
+<pre><code class="language-scala" >final case object IAmACaseObject extends <a href="./CaseImplementThis.md">CaseImplementThis</a> with Product with Serializable with Singleton</pre></code>
 ## Concrete Value Members:
 ### !=
 <pre><code class="language-scala" >final def !=(x$0: Any): Boolean</pre></code>
@@ -27,6 +27,9 @@ example.level2.Documentation
 ### finalize
 <pre><code class="language-scala" >protected def finalize(): Unit</pre></code>
 
+### fromProduct
+<pre><code class="language-scala" >def fromProduct(p: Product): MirroredMonoType</pre></code>
+
 ### getClass
 <pre><code class="language-scala" >final def getClass(): Class[Nothing <: Any]</pre></code>
 

tastydoc/documentation/scala/*:.md

@@ -3,7 +3,7 @@ scala
 
 ## Companion object *:
 
-<pre><code class="language-scala" >sealed class *:[H, T <: scala.Tuple] extends NonEmptyTuple</pre></code>
+<pre><code class="language-scala" >sealed abstract class *:[H, T <: scala.Tuple] extends NonEmptyTuple</pre></code>
 ## Annotations:
 @showAsInfix 
 ## Constructors:
@@ -18,15 +18,21 @@ scala
 
 ### *:
 <pre><code class="language-scala" >inline def *:[H, This >: this.type <: scala.Tuple](x: H): *:[H, This]</pre></code>
+Return a new tuple by prepending the element to `this` tuple.
+This opteration is O(this.size)
 
 ### ++
 <pre><code class="language-scala" >inline def ++[This >: this.type <: scala.Tuple](that: Tuple): <a href="./Tuple.md#Concat">Concat</a>[This, that]</pre></code>
+Return a new tuple by concatenating `this` tuple with `that` tuple.
+This opteration is O(this.size + that.size)
 
 ### ==
 <pre><code class="language-scala" >final def ==(x$0: Any): Boolean</pre></code>
 
 ### apply
 <pre><code class="language-scala" >inline def apply[This >: this.type <: scala.NonEmptyTuple](n: Int): Elem[This, n]</pre></code>
+Get the i-th element of this tuple.
+Equivalent to productElement but with a precise return type.
 
 ### asInstanceOf
 <pre><code class="language-scala" >final def asInstanceOf[X0]: X0</pre></code>
@@ -40,9 +46,6 @@ scala
 ### equals
 <pre><code class="language-scala" >def equals(x$0: Any): Boolean</pre></code>
 
-### fallbackApply
-<pre><code class="language-scala" >inline def fallbackApply(n: Int): Elem[NonEmptyTuple, n]</pre></code>
-
 ### finalize
 <pre><code class="language-scala" >protected def finalize(): Unit</pre></code>
 
@@ -54,6 +57,7 @@ scala
 
 ### head
 <pre><code class="language-scala" >inline def head[This >: this.type <: scala.NonEmptyTuple]: Head[This]</pre></code>
+Get the head of this tuple
 
 ### isInstanceOf
 <pre><code class="language-scala" >final def isInstanceOf[X0]: Boolean</pre></code>
@@ -69,15 +73,19 @@ scala
 
 ### size
 <pre><code class="language-scala" >inline def size[This >: this.type <: scala.Tuple]: <a href="./Tuple.md#Size">Size</a>[This]</pre></code>
+Return the size (or arity) of the tuple
 
 ### synchronized
 <pre><code class="language-scala" >final def synchronized[X0](x$0: X0): X0</pre></code>
 
 ### tail
 <pre><code class="language-scala" >inline def tail[This >: this.type <: scala.NonEmptyTuple]: Tail[This]</pre></code>
+Get the tail of this tuple.
+This opteration is O(this.size)
 
 ### toArray
 <pre><code class="language-scala" >inline def toArray: Array[Object]</pre></code>
+Create a copy this tuple as an Array
 
 ### toString
 <pre><code class="language-scala" >def toString(): String</pre></code>

tastydoc/documentation/scala/Enum.md

@@ -14,6 +14,9 @@ A base trait of all enum classes
 ### ##
 <pre><code class="language-scala" >final def ##: Int</pre></code>
 
+### $ordinal
+<pre><code class="language-scala" >protected def $ordinal: Int</pre></code>
+
 ### ==
 <pre><code class="language-scala" >final def ==(x$0: Any): Boolean</pre></code>
 
@@ -23,10 +26,6 @@ A base trait of all enum classes
 ### clone
 <pre><code class="language-scala" >protected def clone(): Object</pre></code>
 
-### enumTag
-<pre><code class="language-scala" >def enumTag: Int</pre></code>
-A number uniquely identifying a case of an enum
-
 ### eq
 <pre><code class="language-scala" >final def eq(x$0: Object): Boolean</pre></code>
 
@@ -54,6 +53,10 @@ A number uniquely identifying a case of an enum
 ### notifyAll
 <pre><code class="language-scala" >final def notifyAll(): Unit</pre></code>
 
+### ordinal
+<pre><code class="language-scala" >def ordinal: Int</pre></code>
+A number uniquely identifying a case of an enum
+
 ### synchronized
 <pre><code class="language-scala" >final def synchronized[X0](x$0: X0): X0</pre></code>
 

tastydoc/documentation/scala/Eql$.md

@@ -3,7 +3,7 @@ scala
 
 ## Companion trait Eql
 
-<pre><code class="language-scala" >final object Eql extends Serializable</pre></code>
+<pre><code class="language-scala" >final object Eql extends Serializable with Sum</pre></code>
 Companion object containing a few universally known `Eql` instances.
 Eql instances involving primitive types or the Null type are handled directly in
 the compiler (see Implicits.synthesizedEq), so they are not included here.
@@ -13,7 +13,7 @@ derived
 ## Concrete Type Members:
 ### derived
 <pre><code class="language-scala" >final object derived</pre></code>
-A non-implied universal `Eql` instance.
+A universal `Eql` instance.
 
 ## Concrete Value Members:
 ### !=
@@ -37,8 +37,8 @@ A non-implied universal `Eql` instance.
 ### eqlAny
 <pre><code class="language-scala" >def eqlAny[L, R]: Eql[L, R]</pre></code>
 A fall-back instance to compare values of any types.
-Even though this method is not declared implied, the compiler will
-compute implied instances as solutions to `Eql[T, U]` queries if
+Even though this method is not declared a delegate, the compiler will
+synthesize implicit arguments as solutions to `Eql[T, U]` queries if
 the rules of multiversal equality require it.
 
 ### eqlNumber

tastydoc/documentation/scala/Eql$/derived$.md

@@ -2,7 +2,7 @@ scala.Eql$
 # object derived
 
 <pre><code class="language-scala" >final object derived extends Eql[Any, Any] with Serializable</pre></code>
-A non-implied universal `Eql` instance.
+A universal `Eql` instance.
 
 ## Concrete Value Members:
 ### !=

tastydoc/documentation/scala/IArray$package$.md

@@ -3,16 +3,20 @@ scala
 
 <pre><code class="language-scala" >final object IArray$package extends Serializable</pre></code>
 ## Known subclasses:
-IArray
+IArray, arrayOps
 ## Concrete Type Members:
 ### IArray
-<pre><code class="language-scala" >type IArray: [+T >: scala.Nothing <: scala.Any] => scala.IArray$package.IArray.IArray[+T]</pre></code>
+<pre><code class="language-scala" >type IArray: [+T >: scala.Nothing <: scala.Any] => scala.Array[_ >: scala.Nothing <: +T]</pre></code>
 An immutable array. An `IArray[T]` has the same representation as an `Array[T]`,
 but it cannot be updated. Unlike regular arrays, immutable arrays are covariant.
 
 
 ### IArray
 <pre><code class="language-scala" >final object IArray</pre></code>
+### arrayOps
+<pre><code class="language-scala" >final object arrayOps</pre></code>
+Defines extension methods for immutable arrays
+
 ## Concrete Value Members:
 ### !=
 <pre><code class="language-scala" >final def !=(x$0: Any): Boolean</pre></code>

tastydoc/documentation/scala/IArray$package$/IArray$.md

@@ -2,13 +2,6 @@ scala.IArray$package$
 # object IArray
 
 <pre><code class="language-scala" >final object IArray extends Serializable</pre></code>
-## Known subclasses:
-arrayOps
-## Concrete Type Members:
-### arrayOps
-<pre><code class="language-scala" >final object arrayOps</pre></code>
-Defines extension methods for immutable arrays
-
 ## Concrete Value Members:
 ### !=
 <pre><code class="language-scala" >final def !=(x$0: Any): Boolean</pre></code>

tastydoc/documentation/scala/IArray$package$/arrayOps$.md

@@ -0,0 +1,80 @@
+scala.IArray$package$
+# object arrayOps
+
+<pre><code class="language-scala" >final object arrayOps extends Serializable</pre></code>
+Defines extension methods for immutable arrays
+
+## Concrete Value Members:
+### !=
+<pre><code class="language-scala" >final def !=(x$0: Any): Boolean</pre></code>
+
+### ##
+<pre><code class="language-scala" >final def ##: Int</pre></code>
+
+### ==
+<pre><code class="language-scala" >final def ==(x$0: Any): Boolean</pre></code>
+
+### apply
+<pre><code class="language-scala" >inline def apply[T](arr: IArray[T])(n: Int): T</pre></code>
+The selection operation on an immutable array.
+
+***return*** the element of the array at the given index
+
+***n*** the index of the element to select
+
+***arr*** the immutable array
+
+### asInstanceOf
+<pre><code class="language-scala" >final def asInstanceOf[X0]: X0</pre></code>
+
+### clone
+<pre><code class="language-scala" >protected def clone(): Object</pre></code>
+
+### eq
+<pre><code class="language-scala" >final def eq(x$0: Object): Boolean</pre></code>
+
+### equals
+<pre><code class="language-scala" >def equals(x$0: Any): Boolean</pre></code>
+
+### finalize
+<pre><code class="language-scala" >protected def finalize(): Unit</pre></code>
+
+### getClass
+<pre><code class="language-scala" >final def getClass(): Class[Nothing <: Any]</pre></code>
+
+### hashCode
+<pre><code class="language-scala" >def hashCode(): Int</pre></code>
+
+### isInstanceOf
+<pre><code class="language-scala" >final def isInstanceOf[X0]: Boolean</pre></code>
+
+### length
+<pre><code class="language-scala" >inline def length[T](arr: IArray[T]): Int</pre></code>
+The number of elements in an immutable array
+
+***arr*** the immutable array
+
+### ne
+<pre><code class="language-scala" >final def ne(x$0: Object): Boolean</pre></code>
+
+### notify
+<pre><code class="language-scala" >final def notify(): Unit</pre></code>
+
+### notifyAll
+<pre><code class="language-scala" >final def notifyAll(): Unit</pre></code>
+
+### synchronized
+<pre><code class="language-scala" >final def synchronized[X0](x$0: X0): X0</pre></code>
+
+### toString
+<pre><code class="language-scala" >def toString(): String</pre></code>
+
+### wait
+<pre><code class="language-scala" >final def wait(x$0: Long, x$1: Int): Unit</pre></code>
+
+### wait
+<pre><code class="language-scala" >final def wait(x$0: Long): Unit</pre></code>
+
+### wait
+<pre><code class="language-scala" >final def wait(): Unit</pre></code>
+

tastydoc/documentation/scala/NonEmptyTuple.md

@@ -2,6 +2,8 @@ scala
 # trait NonEmptyTuple
 
 <pre><code class="language-scala" >sealed trait NonEmptyTuple extends Tuple</pre></code>
+Tuple of arbitrary non-zero arity
+
 ## Constructors:
 <pre><code class="language-scala" >NonEmptyTuple()</pre></code>
 
@@ -14,15 +16,21 @@ scala
 
 ### *:
 <pre><code class="language-scala" >inline def *:[H, This >: this.type <: scala.Tuple](x: H): *:[H, This]</pre></code>
+Return a new tuple by prepending the element to `this` tuple.
+This opteration is O(this.size)
 
 ### ++
 <pre><code class="language-scala" >inline def ++[This >: this.type <: scala.Tuple](that: Tuple): <a href="./Tuple.md#Concat">Concat</a>[This, that]</pre></code>
+Return a new tuple by concatenating `this` tuple with `that` tuple.
+This opteration is O(this.size + that.size)
 
 ### ==
 <pre><code class="language-scala" >final def ==(x$0: Any): Boolean</pre></code>
 
 ### apply
 <pre><code class="language-scala" >inline def apply[This >: this.type <: scala.NonEmptyTuple](n: Int): Elem[This, n]</pre></code>
+Get the i-th element of this tuple.
+Equivalent to productElement but with a precise return type.
 
 ### asInstanceOf
 <pre><code class="language-scala" >final def asInstanceOf[X0]: X0</pre></code>
@@ -36,9 +44,6 @@ scala
 ### equals
 <pre><code class="language-scala" >def equals(x$0: Any): Boolean</pre></code>
 
-### fallbackApply
-<pre><code class="language-scala" >inline def fallbackApply(n: Int): Elem[NonEmptyTuple, n]</pre></code>
-
 ### finalize
 <pre><code class="language-scala" >protected def finalize(): Unit</pre></code>
 
@@ -50,6 +55,7 @@ scala
 
 ### head
 <pre><code class="language-scala" >inline def head[This >: this.type <: scala.NonEmptyTuple]: Head[This]</pre></code>
+Get the head of this tuple
 
 ### isInstanceOf
 <pre><code class="language-scala" >final def isInstanceOf[X0]: Boolean</pre></code>
@@ -65,15 +71,19 @@ scala
 
 ### size
 <pre><code class="language-scala" >inline def size[This >: this.type <: scala.Tuple]: <a href="./Tuple.md#Size">Size</a>[This]</pre></code>
+Return the size (or arity) of the tuple
 
 ### synchronized
 <pre><code class="language-scala" >final def synchronized[X0](x$0: X0): X0</pre></code>
 
 ### tail
 <pre><code class="language-scala" >inline def tail[This >: this.type <: scala.NonEmptyTuple]: Tail[This]</pre></code>
+Get the tail of this tuple.
+This opteration is O(this.size)
 
 ### toArray
 <pre><code class="language-scala" >inline def toArray: Array[Object]</pre></code>
+Create a copy this tuple as an Array
 
 ### toString
 <pre><code class="language-scala" >def toString(): String</pre></code>