Skip to content

Commit

Permalink
rename dotty.dokka package into dotty.tools.scaladoc
Browse files Browse the repository at this point in the history
  • Loading branch information
romanowski committed Feb 4, 2021
1 parent ed17258 commit ac51595
Show file tree
Hide file tree
Showing 90 changed files with 149 additions and 152 deletions.
2 changes: 1 addition & 1 deletion scaladoc-js/src/Globals.scala
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dotty.dokka
package dotty.tools.scaladoc

import scala.scalajs.js
import scala.scalajs.js.annotation.JSGlobalScope
Expand Down
2 changes: 1 addition & 1 deletion scaladoc-js/src/Main.scala
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dotty.dokka
package dotty.tools.scaladoc

object Main extends App {
Searchbar()
Expand Down
2 changes: 1 addition & 1 deletion scaladoc-js/src/searchbar/PageEntry.scala
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dotty.dokka
package dotty.tools.scaladoc

import scala.scalajs.js

Expand Down
2 changes: 1 addition & 1 deletion scaladoc-js/src/searchbar/Searchbar.scala
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dotty.dokka
package dotty.tools.scaladoc

class Searchbar {
val pages = SearchbarGlobals.pages.toList.map(PageEntry.apply)
Expand Down
2 changes: 1 addition & 1 deletion scaladoc-js/src/searchbar/SearchbarComponent.scala
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dotty.dokka
package dotty.tools.scaladoc

import org.scalajs.dom._
import org.scalajs.dom.html.Input
Expand Down
2 changes: 1 addition & 1 deletion scaladoc-js/src/searchbar/SearchbarGlobals.scala
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dotty.dokka
package dotty.tools.scaladoc

import scala.scalajs.js
import scala.scalajs.js.annotation.JSGlobalScope
Expand Down
2 changes: 1 addition & 1 deletion scaladoc-js/src/searchbar/engine/Matchers.scala
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dotty.dokka
package dotty.tools.scaladoc

enum Matchers extends Function1[PageEntry, Int]:
case ByName(query: String)
Expand Down
2 changes: 1 addition & 1 deletion scaladoc-js/src/searchbar/engine/QueryParser.scala
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dotty.dokka
package dotty.tools.scaladoc

import scala.util.matching.Regex._
import scala.util.matching._
Expand Down
2 changes: 1 addition & 1 deletion scaladoc-js/src/searchbar/engine/SearchbarEngine.scala
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dotty.dokka
package dotty.tools.scaladoc

import math.Ordering.Implicits.seqOrdering

Expand Down
4 changes: 2 additions & 2 deletions scaladoc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,8 @@ You can also find the result of building the same sites for latest `master` at:
### Testing

Most tests rely on comparing signatures (of classes, methods, objects etc.) extracted from the generated documentation
to signatures found in source files. Such tests are defined using [MultipleFileTest](test/dotty/dokka/MultipleFileTest.scala) class
and its subtypes (such as [SingleFileTest](test/dotty/dokka/SingleFileTest.scala))
to signatures found in source files. Such tests are defined using [MultipleFileTest](test/dotty/tools/scala3doc/MultipleFileTest.scala) class
and its subtypes (such as [SingleFileTest](test/dotty/tools/scala3doc/SingleFileTest.scala))

WARNING: As the classes mentioned above are likely to evolve, the description below might easily get out of date.
In case of any discrepancies rely on the source files instead.
Expand Down
2 changes: 1 addition & 1 deletion scaladoc/documentation/docs/design.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@

## Interface

scaladoc is intednted to be use with sbt as well as from commend line or from other buildtools. The main entry point to processing is [Main](dotty.dokka.Main$) class with [[dotty.dokka.Main$.main]].
scaladoc is intednted to be use with sbt as well as from commend line or from other buildtools. The main entry point to processing is [Main](dotty.tools.scaladoc.Main$) class with [[dotty.tools.scaladoc.Main$.main]].
24 changes: 12 additions & 12 deletions scaladoc/scripts/linkstovisit.txt
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
./self/api/dotty.dokka/tasty/comments/wiki/-converter/index.html,on any page try minimizing window to see if relative styles are applied correctly
./self/api/dotty.dokka/-base-key/index.html,is searchbar correct width
./self/api/dotty.dokka/as-map.html,are logos in good propotions
./self/api/dotty.dokka/model/api/as-signature.html,is sidebar not collapsing/overlaying
./self/api/dotty.dokka/-documentable-element/index.html,are overrides pointing to correct function? is filtering working
./self/api/dotty.dokka/model/api/-member/index.html,is source link pointing to correct element (object Member)?
./self/api/dotty.dokka/-scala-content-node/index.html,you can see is graph properly rendered; can you navigate by nodes up and down the hierarchy
./self/api/dotty.tools.scaladoc/tasty/comments/wiki/-converter/index.html,on any page try minimizing window to see if relative styles are applied correctly
./self/api/dotty.tools.scaladoc/-base-key/index.html,is searchbar correct width
./self/api/dotty.tools.scaladoc/as-map.html,are logos in good propotions
./self/api/dotty.tools.scaladoc/model/api/as-signature.html,is sidebar not collapsing/overlaying
./self/api/dotty.tools.scaladoc/-documentable-element/index.html,are overrides pointing to correct function? is filtering working
./self/api/dotty.tools.scaladoc/model/api/-member/index.html,is source link pointing to correct element (object Member)?
./self/api/dotty.tools.scaladoc/-scala-content-node/index.html,you can see is graph properly rendered; can you navigate by nodes up and down the hierarchy
./self/api/index/index.html,package overview
./self/api/dotty.dokka/index.html,example package
./self/api/dotty.dokka/-documentable-element/index.html,example classlike
./self/api/dotty.dokka/get-from-extra.html,example package level method
./self/api/dotty.dokka/put.html,example extension
./self/api/dotty.dokka/-dot-diagram-builder/build.html,example method
./self/api/dotty.tools.scaladoc/index.html,example package
./self/api/dotty.tools.scaladoc/-documentable-element/index.html,example classlike
./self/api/dotty.tools.scaladoc/get-from-extra.html,example package level method
./self/api/dotty.tools.scaladoc/put.html,example extension
./self/api/dotty.tools.scaladoc/-dot-diagram-builder/build.html,example method
2 changes: 1 addition & 1 deletion scaladoc/src/dotty/tools/dottydoc/Main.scala
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ object Main extends Driver:
* how they're split).
*/
override def process(args: Array[String], rootCtx: Context): Reporter =
dotty.dokka.Scaladoc.run(args, rootCtx)
dotty.tools.scaladoc.Scaladoc.run(args, rootCtx)
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dotty.dokka
package dotty.tools.scaladoc

import java.nio.file.Path

Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
package dotty.dokka
package dotty.tools.scaladoc

import java.io.File
import java.nio.file.Files
import java.nio.file.Path
import java.nio.file.Paths

import collection.JavaConverters._
import dotty.dokka.site.StaticSiteContext
import dotty.tools.scaladoc.site.StaticSiteContext
import dotty.tools.dotc.core.Contexts._
import dotty.tools.io.VirtualFile
import dotty.tools.dotc.util.SourceFile
Expand Down Expand Up @@ -71,9 +71,6 @@ case class NavigationNode(name: String, dri: DRI, nested: Seq[NavigationNode])
case class DocContext(args: Scaladoc.Args, compilerContext: CompilerContext):
lazy val sourceLinks: SourceLinks = SourceLinks.load(using this)

// Nasty hack but will get rid of it once we migrate away from dokka renderer
var navigationNode: Option[NavigationNode] = None

lazy val staticSiteContext = args.docsRoot.map(path => StaticSiteContext(
File(path).getAbsoluteFile(),
args,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dotty.dokka
package dotty.tools.scaladoc

import java.net.URL
import scala.util.matching._
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dotty.dokka
package dotty.tools.scaladoc

import java.util.ServiceLoader
import java.io.File
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package dotty.dokka
package dotty.tools.scaladoc

import dotty.dokka.tasty.DokkaTastyInspector
import dotty.tools.scaladoc.tasty.DokkaTastyInspector
import collection.JavaConverters._
import transformers._

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dotty.dokka
package dotty.tools.scaladoc

import java.util.ServiceLoader
import java.io.File
Expand Down Expand Up @@ -65,11 +65,11 @@ object Scaladoc:
ctx.reporter


private [dokka] def run(args: Args)(using ctx: CompilerContext): DocContext =
private [scaladoc] def run(args: Args)(using ctx: CompilerContext): DocContext =
given docContext: DocContext = new DocContext(args, ctx)
val module = ScalaModuleProvider.mkModule()

new dotty.dokka.renderers.HtmlRenderer(module.rootPackage, module.members).render()
new dotty.tools.scaladoc.renderers.HtmlRenderer(module.rootPackage, module.members).render()
report.inform("generation completed successfully")
docContext

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dotty.dokka
package dotty.tools.scaladoc

import java.util.ServiceLoader
import java.io.File
Expand All @@ -10,7 +10,7 @@ import java.nio.file.Files

import dotty.tools.dotc.config.Settings._
import dotty.tools.dotc.config.CommonScalaSettings
import dotty.dokka.Scaladoc._
import dotty.tools.scaladoc.Scaladoc._

class ScaladocArgs extends SettingGroup with CommonScalaSettings:
val unsupportedSettings = Seq(
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dotty.dokka
package dotty.tools.scaladoc

import java.nio.file.Path
import java.nio.file.Paths
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package dotty.dokka
package dotty.tools.scaladoc

import dotty.dokka.tasty.comments.Comment
import dotty.tools.scaladoc.tasty.comments.Comment

enum Visibility(val name: String):
case Unrestricted extends Visibility("")
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
package dotty.dokka
package dotty.tools.scaladoc

import java.util.stream.Stream // comment out - wrong error!
import java.util.stream.Collectors
import java.util.Collections
import java.nio.file.Path
import com.vladsch.flexmark.util.ast.{Node => MdNode}
import dotty.dokka.tasty.comments.wiki.WikiDocElement
import dotty.tools.scaladoc.tasty.comments.wiki.WikiDocElement
import collection.JavaConverters._

def JList[T](e: T*): JList[T] = e.asJava
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dotty.dokka
package dotty.tools.scaladoc
package renderers

import util.HTML._
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
package dotty.dokka
package dotty.tools.scaladoc
package renderers

import util.HTML._
import collection.JavaConverters._
import java.net.URI
import java.net.URL
import dotty.dokka.site._
import dotty.tools.scaladoc.site._
import scala.util.Try
import org.jsoup.Jsoup
import java.nio.file.Paths
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
package dotty.dokka
package dotty.tools.scaladoc
package renderers

import util.HTML._
import collection.JavaConverters._
import java.net.URI
import java.net.URL
import dotty.dokka.site._
import dotty.tools.scaladoc.site._
import scala.util.Try
import org.jsoup.Jsoup
import java.nio.file.Paths
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
package dotty.dokka
package dotty.tools.scaladoc
package renderers

import scala.collection.immutable.SortedMap
import util.HTML._
import collection.JavaConverters._
import dotty.dokka.translators.FilterAttributes
import dotty.dokka.tasty.comments.markdown.DocFlexmarkRenderer
import dotty.tools.scaladoc.translators.FilterAttributes
import dotty.tools.scaladoc.tasty.comments.markdown.DocFlexmarkRenderer
import com.vladsch.flexmark.util.ast.{Node => MdNode}
import dotty.dokka.tasty.comments.wiki.WikiDocElement
import dotty.tools.scaladoc.tasty.comments.wiki.WikiDocElement
import translators._

class MemberRenderer(signatureRenderer: SignatureRenderer)(using DocContext) extends DocRender(signatureRenderer):
Expand Down
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
package dotty.dokka
package dotty.tools.scaladoc
package renderers

import util.HTML._
import collection.JavaConverters._
import java.net.URI
import java.net.URL
import dotty.dokka.site._
import dotty.tools.scaladoc.site._
import scala.util.Try
import org.jsoup.Jsoup
import java.nio.file.Paths
import java.nio.file.Path
import java.nio.file.Files
import java.io.File
import dotty.dokka.translators.FilterAttributes
import dotty.tools.scaladoc.translators.FilterAttributes
import util._
import translators._

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dotty.dokka
package dotty.tools.scaladoc
package renderers

import util.HTML._
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
package dotty.dokka
package dotty.tools.scaladoc
package renderers

import util.HTML._
import collection.JavaConverters._
import java.net.URI
import java.net.URL
import dotty.dokka.site._
import dotty.tools.scaladoc.site._
import scala.util.Try
import org.jsoup.Jsoup
import java.nio.file.Paths
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
package dotty.dokka
package dotty.tools.scaladoc
package renderers

import dotty.dokka.tasty.comments.wiki._
import dotty.tools.scaladoc.tasty.comments.wiki._
import util.HTML._
import com.vladsch.flexmark.util.ast.{Node => MdNode}
import dotty.dokka.tasty.comments.wiki.WikiDocElement
import dotty.dokka.tasty.comments.markdown.DocFlexmarkRenderer
import dotty.tools.scaladoc.tasty.comments.wiki.WikiDocElement
import dotty.tools.scaladoc.tasty.comments.markdown.DocFlexmarkRenderer

class DocRender(signatureRenderer: SignatureRenderer)(using DocContext):

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dotty.dokka
package dotty.tools.scaladoc
package renderers

import java.io.InputStream
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dotty.dokka
package dotty.tools.scaladoc
package site

import java.io.File
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dotty.dokka
package dotty.tools.scaladoc
package site

import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dotty.dokka
package dotty.tools.scaladoc
package site

import java.io.File
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dotty.dokka
package dotty.tools.scaladoc
package site

import java.io.File
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package dotty.dokka
package dotty.tools.scaladoc
package site

import java.io.File
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
package dotty.dokka
package dotty.tools.scaladoc
package tasty

import collection.JavaConverters._
import dotty.dokka._
import dotty.tools.scaladoc._
import scala.quoted._

trait BasicSupport:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
package dotty.dokka.tasty
package dotty.tools.scaladoc.tasty

import collection.JavaConverters._
import dotty.dokka._
import dotty.dokka.{Signature => DSignature}
import dotty.tools.scaladoc._
import dotty.tools.scaladoc.{Signature => DSignature}

trait ClassLikeSupport:
self: TastyParser =>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
package dotty.dokka.tasty
package dotty.tools.scaladoc.tasty

import dotty.dokka._
import dotty.tools.scaladoc._

trait NameNormalizer { self: TastyParser =>
import qctx.reflect._
Expand Down
Loading

0 comments on commit ac51595

Please sign in to comment.