diff --git a/.github/workflows/scala3doc.yaml b/.github/workflows/scaladoc.yaml similarity index 74% rename from .github/workflows/scala3doc.yaml rename to .github/workflows/scaladoc.yaml index 590a98776c05..e22b79929335 100644 --- a/.github/workflows/scala3doc.yaml +++ b/.github/workflows/scaladoc.yaml @@ -1,4 +1,4 @@ -name: Scala3doc +name: scaladoc on: push: @@ -12,7 +12,7 @@ jobs: && !contains(github.event.pull_request.body, '[skip ci]') && !contains(github.event.pull_request.body, '[skip docs]') ) - || contains(github.event.ref, 'scala3doc') + || contains(github.event.ref, 'scaladoc') || contains(github.event.ref, 'master')" steps: @@ -36,25 +36,25 @@ jobs: java-version: 11 - name: Compile and test - run: ./project/scripts/sbt scala3doc/test + run: ./project/scripts/sbt scaladoc/test - name: Locally publish self - run: ./project/scripts/sbt scala3doc/publishLocal + run: ./project/scripts/sbt scaladoc/publishLocal - name: Generate self documentation - run: ./project/scripts/sbt scala3doc/generateSelfDocumentation + run: ./project/scripts/sbt scaladoc/generateSelfDocumentation - name: Generate testcases documentation - run: ./project/scripts/sbt scala3doc/generateTestcasesDocumentation + run: ./project/scripts/sbt scaladoc/generateTestcasesDocumentation - name: Generate Scala 3 documentation - run: ./project/scripts/sbt scala3doc/generateScala3Documentation + run: ./project/scripts/sbt scaladoc/generatescaladocumentation - name: Generate documentation for example project using dotty-sbt - run: ./project/scripts/sbt "sbt-dotty/scripted sbt-dotty/scala3doc" + run: ./project/scripts/sbt "sbt-dotty/scripted sbt-dotty/scaladoc" - name: Generate index file - run: scala3doc/scripts/mk-index.sh scala3doc/output > scala3doc/output/index.html + run: scaladoc/scripts/mk-index.sh scaladoc/output > scaladoc/output/index.html - name: Upload documentation to server uses: azure/CLI@v1 @@ -64,9 +64,9 @@ jobs: with: inlineScript: | DOC_DEST=pr-${PR_NUMBER:-${GITHUB_REF##*/}} - echo uplading docs to https://scala3doc.virtuslab.com/$DOC_DEST - az storage container create --name $DOC_DEST --account-name scala3docstorage --public-access container - az storage blob sync -s scala3doc/output -c $DOC_DEST --account-name scala3docstorage + echo uplading docs to https://scaladoc.virtuslab.com/$DOC_DEST + az storage container create --name $DOC_DEST --account-name scaladocstorage --public-access container + az storage blob sync -s scaladoc/output -c $DOC_DEST --account-name scaladocstorage community-docs: env: @@ -76,7 +76,7 @@ jobs: && !contains(github.event.pull_request.body, '[skip ci]') && !contains(github.event.pull_request.body, '[skip docs]') ) - || contains(github.event.ref, 'scala3doc') + || contains(github.event.ref, 'scaladoc') || contains(github.event.ref, 'master')" steps: @@ -102,6 +102,6 @@ jobs: with: inlineScript: | DOC_DEST=pr-${PR_NUMBER:-${GITHUB_REF##*/}}-docs - echo uplading docs to https://scala3doc.virtuslab.com/$DOC_DEST - az storage container create --name $DOC_DEST --account-name scala3docstorage --public-access container - az storage blob sync -s community-build/docsOutput -c $DOC_DEST --account-name scala3docstorage + echo uplading docs to https://scaladoc.virtuslab.com/$DOC_DEST + az storage container create --name $DOC_DEST --account-name scaladocstorage --public-access container + az storage blob sync -s community-build/docsOutput -c $DOC_DEST --account-name scaladocstorage diff --git a/build.sbt b/build.sbt index b592aeaded08..f4701a1034bf 100644 --- a/build.sbt +++ b/build.sbt @@ -20,9 +20,9 @@ val `stdlib-bootstrapped-tasty-tests` = Build.`stdlib-bootstrapped-tasty-tests` val `tasty-core` = Build.`tasty-core` val `tasty-core-bootstrapped` = Build.`tasty-core-bootstrapped` val `tasty-core-scala2` = Build.`tasty-core-scala2` -val scala3doc = Build.scala3doc -val `scala3doc-testcases` = Build.`scala3doc-testcases` -val `scala3doc-js` = Build.`scala3doc-js` +val scaladoc = Build.scaladoc +val `scaladoc-testcases` = Build.`scaladoc-testcases` +val `scaladoc-js` = Build.`scaladoc-js` val `scala3-bench-run` = Build.`scala3-bench-run` val dist = Build.dist val `community-build` = Build.`community-build` diff --git a/community-build/src/scala/dotty/communitybuild/Main.scala b/community-build/src/scala/dotty/communitybuild/Main.scala index 76f854d7f179..a4f56a8ac0c7 100644 --- a/community-build/src/scala/dotty/communitybuild/Main.scala +++ b/community-build/src/scala/dotty/communitybuild/Main.scala @@ -12,7 +12,7 @@ object Main: val name = project.project try project.doc() - val pathsOut = s"find community-projects/$name/ -name 'scala3doc.version'".!! + val pathsOut = s"find community-projects/$name/ -name 'scaladoc.version'".!! pathsOut.linesIterator.map(Paths.get(_).getParent).toList catch case e: Exception => diff --git a/community-build/src/scala/dotty/communitybuild/projects.scala b/community-build/src/scala/dotty/communitybuild/projects.scala index 16c199b0aed9..4675750f6b84 100644 --- a/community-build/src/scala/dotty/communitybuild/projects.scala +++ b/community-build/src/scala/dotty/communitybuild/projects.scala @@ -162,12 +162,12 @@ final case class SbtCommunityProject( override val publishCommand = if sbtPublishCommand eq null then null else val disableDocCommand = - if sbtDocCommand eq null then "" else "set every useScala3doc := false;" + if sbtDocCommand eq null then "" else "set every usescaladoc := false;" s"$baseCommand$disableDocCommand$sbtPublishCommand" override val docCommand = if sbtDocCommand eq null then null else val cmd = if sbtDocCommand.startsWith(";") then sbtDocCommand else s";$sbtDocCommand" - s"$baseCommand set every useScala3doc := true; set every doc/logLevel := Level.Warn $cmd " + s"$baseCommand set every usescaladoc := true; set every doc/logLevel := Level.Warn $cmd " override val runCommandsArgs: List[String] = // Run the sbt command with the compiler version and sbt plugin set in the build diff --git a/compiler/src/dotty/tools/dotc/config/ScalaSettings.scala b/compiler/src/dotty/tools/dotc/config/ScalaSettings.scala index eabd20d71f33..3c039eb2212a 100644 --- a/compiler/src/dotty/tools/dotc/config/ScalaSettings.scala +++ b/compiler/src/dotty/tools/dotc/config/ScalaSettings.scala @@ -7,7 +7,7 @@ import PathResolver.Defaults import rewrites.Rewrites import Settings.Setting -/** Settings shared by compiler and scala3doc */ +/** Settings shared by compiler and scaladoc */ trait CommonScalaSettings { self: Settings.SettingGroup => protected def defaultClasspath: String = sys.env.getOrElse("CLASSPATH", ".") @@ -227,7 +227,7 @@ class ScalaSettings extends Settings.SettingGroup with CommonScalaSettings { val Yinstrument: Setting[Boolean] = BooleanSetting("-Yinstrument", "Add instrumentation code that counts allocations and closure creations.") val YinstrumentDefs: Setting[Boolean] = BooleanSetting("-Yinstrument-defs", "Add instrumentation code that counts method calls; needs -Yinstrument to be set, too.") - /** Dottydoc specific settings that are not used in scala3doc */ + /** Dottydoc specific settings that are not used in scaladoc */ val docSnapshot: Setting[Boolean] = BooleanSetting("-doc-snapshot", "Generate a documentation snapshot for the current Dotty version") val projectUrl: Setting[String] = StringSetting ( diff --git a/docs/blog/_posts/2020-12-18-scala3-m3.md b/docs/blog/_posts/2020-12-18-scala3-m3.md index e0cba2b144d8..9eee6359f77c 100644 --- a/docs/blog/_posts/2020-12-18-scala3-m3.md +++ b/docs/blog/_posts/2020-12-18-scala3-m3.md @@ -133,9 +133,9 @@ You can read the discussion of this change in the [PR #10670](https://github.com # Tooling improvements As we are getting closer to a stable release of Scala 3, the focus increasingly shifts on the tooling available to get started with Scala 3. -For a while now, we are not using the old dottydoc documentation tool for building the documentation. We are developing an entirely new tool, scala3doc, from scratch. This new documentation tool is more robust and faster than the old one. +For a while now, we are not using the old dottydoc documentation tool for building the documentation. We are developing an entirely new tool, scaladoc, from scratch. This new documentation tool is more robust and faster than the old one. -As part of the tooling effort, this new Scala 3 documentation tool is rapidly improved. [PR #10522](https://github.com/lampepfl/dotty/pull/10522) proves that the doctool can generate documentation for the community build projects. You can access this documentation via the following [link](https://scala3doc.virtuslab.com/pr-master-docs/index.html). +As part of the tooling effort, this new Scala 3 documentation tool is rapidly improved. [PR #10522](https://github.com/lampepfl/dotty/pull/10522) proves that the doctool can generate documentation for the community build projects. You can access this documentation via the following [link](https://scaladoc.virtuslab.com/pr-master-docs/index.html). [PR #10491](https://github.com/lampepfl/dotty/pull/10491) introduced scripting support in Scala 3. Consider the following source named `Main.scala`: diff --git a/docs/docs/usage/scala3doc/blog.md b/docs/docs/usage/scaladoc/blog.md similarity index 67% rename from docs/docs/usage/scala3doc/blog.md rename to docs/docs/usage/scaladoc/blog.md index af257074dce9..4770d6514f75 100644 --- a/docs/docs/usage/scala3doc/blog.md +++ b/docs/docs/usage/scaladoc/blog.md @@ -4,6 +4,6 @@ title: Built-in blog # {{page.title}} -Scala3doc allows you to include a simple blog in your documentation. For now, it +scaladoc allows you to include a simple blog in your documentation. For now, it provides only basic features. In the future, we plan to include more advanced features like tagging or author pages. diff --git a/docs/docs/usage/scala3doc/docComments.md b/docs/docs/usage/scaladoc/docComments.md similarity index 96% rename from docs/docs/usage/scala3doc/docComments.md rename to docs/docs/usage/scaladoc/docComments.md index cd33cf3000e1..12e93623fbd9 100644 --- a/docs/docs/usage/scala3doc/docComments.md +++ b/docs/docs/usage/scaladoc/docComments.md @@ -4,7 +4,7 @@ title: API Documentation # {{ page.title }} -Scala3doc's main feature is creating API documentation from code comments. +scaladoc's main feature is creating API documentation from code comments. By default, the code comments are understood as Markdown, though we also support Scaladoc's old [Wiki syntax](https://docs.scala-lang.org/style/scaladoc.html). @@ -75,7 +75,7 @@ closer together. The new features are: def foo = `([.abusive.])` ``` Scaladoc required backslash-escaping to reference such identifiers. Instead, - Scala3doc allows using the familiar Scala backtick quotation. + scaladoc allows using the familiar Scala backtick quotation. #### Why keep the Wiki syntax for links? diff --git a/docs/docs/usage/scala3doc/index.md b/docs/docs/usage/scaladoc/index.md similarity index 69% rename from docs/docs/usage/scala3doc/index.md rename to docs/docs/usage/scaladoc/index.md index 2603ebf76256..a13b4eab3c0b 100644 --- a/docs/docs/usage/scala3doc/index.md +++ b/docs/docs/usage/scaladoc/index.md @@ -1,12 +1,12 @@ --- -title: Scala3doc +title: scaladoc --- -![Scala3doc logo](/images/scala3doc-logo.png) +![scaladoc logo](/images/scaladoc-logo.png) -Scala3doc is tool to generate documentation for your Scala 3 projects. It provies similar features to `javadoc` or `scaladoc` as well as `jekyll` or `docusaurus`. +scaladoc is tool to generate documentation for your Scala 3 projects. It provies similar features to `javadoc` or `scaladoc` as well as `jekyll` or `docusaurus`. -As you probably have guessed, this whole site was created using Scala3doc. +As you probably have guessed, this whole site was created using scaladoc. {% for post in site.posts %} diff --git a/docs/docs/usage/scala3doc/specificTags.md b/docs/docs/usage/scaladoc/specificTags.md similarity index 65% rename from docs/docs/usage/scala3doc/specificTags.md rename to docs/docs/usage/scaladoc/specificTags.md index 9429a0c333e7..09619f6fce94 100644 --- a/docs/docs/usage/scala3doc/specificTags.md +++ b/docs/docs/usage/scaladoc/specificTags.md @@ -1,15 +1,15 @@ --- -title: Scala3doc-specific Tags and Features +title: scaladoc-specific Tags and Features --- # {{page.title}} -Scala3doc extends Markdown with additional features, such as linking +scaladoc extends Markdown with additional features, such as linking to API definitions. This can be used from within static documentation and blog posts to provide blend-in content. ## Linking to API -Scala3doc allows linking to API documentation with Wiki-style links. Linking to +scaladoc allows linking to API documentation with Wiki-style links. Linking to `scala.collection.immutable.List` is as simple as `[[scala.collection.immutable.List]]`. For more information on the exact syntax, see [doc comment documentation](./docComments.html#definition-links). diff --git a/docs/docs/usage/scala3doc/staticSite.md b/docs/docs/usage/scaladoc/staticSite.md similarity index 79% rename from docs/docs/usage/scala3doc/staticSite.md rename to docs/docs/usage/scaladoc/staticSite.md index 5fb07ffd5e1b..ec8640f986c0 100644 --- a/docs/docs/usage/scala3doc/staticSite.md +++ b/docs/docs/usage/scaladoc/staticSite.md @@ -4,7 +4,7 @@ title: Static documentation # {{ page.title}} -Scala3doc is able to generate static sites, known from [Jekyll](http://jekyllrb.com/) or [Docusaurus](https://docusaurus.io/). +scaladoc is able to generate static sites, known from [Jekyll](http://jekyllrb.com/) or [Docusaurus](https://docusaurus.io/). Having a combined tool allows to provide interaction between static documentation and API, thus allowing the two to blend naturally. Creating a site is just as simple as in Jekyll. The site root contains the @@ -29,18 +29,18 @@ index.html docs/getting-started.html ``` -Scala3doc can transform both files and directories (to organize your documentation into tree-like structure). By default directories has title based on file name and has empty content. There is an option to include `index.html` or `index.md` (not both) to provide both content and properties like title (see [Properties](#properties)). +scaladoc can transform both files and directories (to organize your documentation into tree-like structure). By default directories has title based on file name and has empty content. There is an option to include `index.html` or `index.md` (not both) to provide both content and properties like title (see [Properties](#properties)). ## Properties -Scala3doc uses the [Liquid](https://shopify.github.io/liquid/) templating engine +scaladoc uses the [Liquid](https://shopify.github.io/liquid/) templating engine and provides a number of custom filters and tags specific to Scala documentation. -In Scala3doc, all templates can contain YAML front-matter. The front-matter +In scaladoc, all templates can contain YAML front-matter. The front-matter is parsed and put into the `page` variable available in templates via Liquid. -Scala3doc uses some predefined properties to controls some aspect of page. +scaladoc uses some predefined properties to controls some aspect of page. Predefined properties: @@ -94,7 +94,7 @@ Layouts must be placed in a `_layouts` directory in the site root: Sidebar ======= -Scala3doc by default uses layout of files in `docs` directory to create table of content. There is also ability to override it by providing a `sidebar.yml` file in the site root: +scaladoc by default uses layout of files in `docs` directory to create table of content. There is also ability to override it by providing a `sidebar.yml` file in the site root: ```yaml sidebar: diff --git a/docs/images/scala3doc-logo.png b/docs/images/scaladoc-logo.png similarity index 100% rename from docs/images/scala3doc-logo.png rename to docs/images/scaladoc-logo.png diff --git a/docs/sidebar.yml b/docs/sidebar.yml index c48e8e46ee79..a1566f7cdd86 100644 --- a/docs/sidebar.yml +++ b/docs/sidebar.yml @@ -15,8 +15,8 @@ sidebar: url: docs/usage/language-versions.html - title: cbt-projects url: docs/usage/cbt-projects.html - - title: Scala3doc - url: docs/usage/scala3doc + - title: scaladoc + url: docs/usage/scaladoc - title: Dottydoc [Legacy] url: docs/usage/dottydoc.html - title: Reference diff --git a/project/Build.scala b/project/Build.scala index 8f44b0807c20..63c6dcbb2a03 100644 --- a/project/Build.scala +++ b/project/Build.scala @@ -1227,12 +1227,12 @@ object Build { val testDocumentationRoot = taskKey[String]("Root directory where tests documentation are stored") val generateSelfDocumentation = taskKey[Unit]("Generate example documentation") // Note: the two tasks below should be one, but a bug in Tasty prevents that - val generateScala3Documentation = inputKey[Unit]("Generate documentation for dotty lib") + val generatescaladocumentation = inputKey[Unit]("Generate documentation for dotty lib") val generateTestcasesDocumentation = taskKey[Unit]("Generate documentation for testcases, usefull for debugging tests") - lazy val `scala3doc` = project.in(file("scala3doc")).asScala3doc - lazy val `scala3doc-testcases` = project.in(file("scala3doc-testcases")).asScala3docTestcases + lazy val `scaladoc` = project.in(file("scaladoc")).asscaladoc + lazy val `scaladoc-testcases` = project.in(file("scaladoc-testcases")).asscaladocTestcases - lazy val `scala3doc-js` = project.in(file("scala3doc-js")).asScala3docJs + lazy val `scaladoc-js` = project.in(file("scaladoc-js")).asscaladocJs // sbt plugin to use Dotty in your own build, see // https://github.com/lampepfl/scala3-example-project for usage. @@ -1280,7 +1280,7 @@ object Build { publishLocal in `scala3-staging`, publishLocal in `scala3-tasty-inspector`, publishLocal in `scala3-doc-bootstrapped`, - publishLocal in `scala3doc`, + publishLocal in `scaladoc`, publishLocal in `scala3-bootstrapped` // Needed because sbt currently hardcodes the dotty artifact ).evaluated ) @@ -1351,7 +1351,7 @@ object Build { (publishLocal in `scala3-library-bootstrapped`).value (publishLocal in `scala3-doc-bootstrapped`).value (publishLocal in `scala3-tasty-inspector`).value - (publishLocal in `scala3doc`).value + (publishLocal in `scaladoc`).value (publishLocal in `scala3-compiler-bootstrapped`).value (publishLocal in `sbt-dotty`).value (publishLocal in `scala3-bootstrapped`).value @@ -1484,7 +1484,7 @@ object Build { def asDottyRoot(implicit mode: Mode): Project = project.withCommonSettings. aggregate(`scala3-interfaces`, dottyLibrary, dottyCompiler, tastyCore, dottyDoc, `scala3-sbt-bridge`). bootstrappedAggregate(`scala3-language-server`, `scala3-staging`, `scala3-tasty-inspector`, - `scala3-library-bootstrappedJS`, scala3doc). + `scala3-library-bootstrappedJS`, scaladoc). dependsOn(tastyCore). dependsOn(dottyCompiler). dependsOn(dottyLibrary). @@ -1531,7 +1531,7 @@ object Build { settings(commonBenchmarkSettings). enablePlugins(JmhPlugin) - def asScala3doc: Project = { + def asscaladoc: Project = { def generateDocumentation(targets: String, name: String, outDir: String, ref: String, params: String = "") = Def.taskDyn { val projectVersion = version.value IO.createDirectory(file(outDir)) @@ -1567,25 +1567,25 @@ object Build { "com.novocode" % "junit-interface" % "0.11" % "test", ), - Test / test := (Test / test).dependsOn(compile.in(Compile).in(`scala3doc-testcases`)).value, - testcasesOutputDir.in(Test) := joinProducts((`scala3doc-testcases`/Compile/products).value), - testcasesSourceRoot.in(Test) := (baseDirectory.in(`scala3doc-testcases`).value / "src").getAbsolutePath.toString, + Test / test := (Test / test).dependsOn(compile.in(Compile).in(`scaladoc-testcases`)).value, + testcasesOutputDir.in(Test) := joinProducts((`scaladoc-testcases`/Compile/products).value), + testcasesSourceRoot.in(Test) := (baseDirectory.in(`scaladoc-testcases`).value / "src").getAbsolutePath.toString, Compile / mainClass := Some("dotty.dokka.Main"), baseDirectory.in(run) := baseDirectory.in(ThisBuild).value, generateSelfDocumentation := Def.taskDyn { generateDocumentation( classDirectory.in(Compile).value.getAbsolutePath, - "scala3doc", "scala3doc/output/self", VersionUtil.gitHash, - "-siteroot scala3doc/documentation -project-logo scala3doc/documentation/logo.svg " + + "scaladoc", "scaladoc/output/self", VersionUtil.gitHash, + "-siteroot scaladoc/documentation -project-logo scaladoc/documentation/logo.svg " + "-external-mappings:" + - ".*scala.*::scala3doc::http://dotty.epfl.ch/api/," + + ".*scala.*::scaladoc3::http://dotty.epfl.ch/api/," + ".*java.*::javadoc::https://docs.oracle.com/javase/8/docs/api/" ) }.value, - generateScala3Documentation := Def.inputTaskDyn { + generatescaladocumentation := Def.inputTaskDyn { val dottydocExtraArgs = spaceDelimited("[output]").parsed - val dest = file(dottydocExtraArgs.headOption.getOrElse("scala3doc/output/scala3")).getAbsoluteFile + val dest = file(dottydocExtraArgs.headOption.getOrElse("scaladoc/output/scala3")).getAbsoluteFile val majorVersion = (scalaBinaryVersion in LocalProject("scala3-library-bootstrapped")).value val dottyJars: Seq[java.io.File] = Seq( @@ -1611,7 +1611,7 @@ object Build { }.dependsOn(generateDocumentation( roots, "Scala 3", dest.getAbsolutePath, "master", // contains special definitions which are "transplanted" elsewhere - // and which therefore confuse Scala3doc when accessed from this pkg + // and which therefore confuse scaladoc when accessed from this pkg "-skip-by-id:scala.runtime.stdLibPatches " + // MatchCase is a special type that represents match type cases, // Reflect doesn't expect to see it as a standalone definition @@ -1619,7 +1619,7 @@ object Build { "-skip-by-id:scala.runtime.MatchCase " + "-skip-by-regex:.+\\.internal($|\\..+) " + "-skip-by-regex:.+\\.impl($|\\..+) " + - "-comment-syntax wiki -siteroot scala3doc/scala3-docs -project-logo scala3doc/scala3-docs/logo.svg " + + "-comment-syntax wiki -siteroot scaladoc/scala3-docs -project-logo scaladoc/scala3-docs/logo.svg " + "-external-mappings:.*java.*::javadoc::https://docs.oracle.com/javase/8/docs/api/ " + s"-source-links:$stdLibRoot=github://scala/scala/v${stdlibVersion(Bootstrapped)}#src/library " + s"-doc-root-content $docRootFile" @@ -1627,7 +1627,7 @@ object Build { }.evaluated, generateTestcasesDocumentation := Def.taskDyn { - generateDocumentation(Build.testcasesOutputDir.in(Test).value, "Scala3doc testcases", "scala3doc/output/testcases", "master") + generateDocumentation(Build.testcasesOutputDir.in(Test).value, "scaladoc testcases", "scaladoc/output/testcases", "master") }.value, buildInfoKeys in Test := Seq[BuildInfoKey]( @@ -1639,12 +1639,12 @@ object Build { Compile / buildInfoPackage := "dotty.dokka", Compile / resourceGenerators += Def.task { val jsDestinationFile = (Compile / resourceManaged).value / "dotty_res" / "scripts" / "searchbar.js" - sbt.IO.copyFile((fullOptJS in Compile in `scala3doc-js`).value.data, jsDestinationFile) + sbt.IO.copyFile((fullOptJS in Compile in `scaladoc-js`).value.data, jsDestinationFile) Seq(jsDestinationFile) }.taskValue, Compile / resourceGenerators += Def.task { - val cssDesitnationFile = (Compile / resourceManaged).value / "dotty_res" / "styles" / "scala3doc-searchbar.css" - val cssSourceFile = (resourceDirectory in Compile in `scala3doc-js`).value / "scala3doc-searchbar.css" + val cssDesitnationFile = (Compile / resourceManaged).value / "dotty_res" / "styles" / "scaladoc-searchbar.css" + val cssSourceFile = (resourceDirectory in Compile in `scaladoc-js`).value / "scaladoc-searchbar.css" FileFunction.cached(streams.value.cacheDirectory / "css-cache") { (in: Set[File]) => in.headOption.map(sbt.IO.copyFile(_, cssDesitnationFile)) Set(cssDesitnationFile) @@ -1658,10 +1658,10 @@ object Build { ) } - def asScala3docTestcases: Project = + def asscaladocTestcases: Project = project.dependsOn(`scala3-compiler-bootstrapped`).settings(commonBootstrappedSettings) - def asScala3docJs: Project = + def asscaladocJs: Project = project. enablePlugins(MyScalaJSPlugin). dependsOn(`scala3-library-bootstrappedJS`). diff --git a/project/scripts/genDocs b/project/scripts/genDocs index 00666859ec10..c5044cc1ccd2 100755 --- a/project/scripts/genDocs +++ b/project/scripts/genDocs @@ -25,7 +25,7 @@ git checkout "$GIT_HEAD" ### Generate the current snapshot of the website ### # this command will generate docs in $PWD/docs/_site SBT="$SCRIPT_DIR/sbt" -"$SBT" "scala3doc/generateScala3Documentation docs/_site" +"$SBT" "scaladoc/generatescaladocumentation docs/_site" # make sure that the previous command actually succeeded if [ ! -d "$SITE_OUT_DIR" ]; then diff --git a/sbt-dotty/sbt-test/sbt-dotty/scala3doc/build.sbt b/sbt-dotty/sbt-test/sbt-dotty/scala3doc/build.sbt deleted file mode 100644 index 7572bdd2a543..000000000000 --- a/sbt-dotty/sbt-test/sbt-dotty/scala3doc/build.sbt +++ /dev/null @@ -1,7 +0,0 @@ -scalaVersion := sys.props("plugin.scalaVersion") - -lazy val assertUsingScala3doc = taskKey[Unit]("") - -assertUsingScala3doc := { - assert(useScala3doc.value) -} diff --git a/sbt-dotty/sbt-test/sbt-dotty/scala3doc/test b/sbt-dotty/sbt-test/sbt-dotty/scala3doc/test deleted file mode 100644 index 7a90f305effb..000000000000 --- a/sbt-dotty/sbt-test/sbt-dotty/scala3doc/test +++ /dev/null @@ -1,3 +0,0 @@ -> assertUsingScala3doc -> doc - diff --git a/sbt-dotty/sbt-test/sbt-dotty/scala3doc-empty-test/build.sbt b/sbt-dotty/sbt-test/sbt-dotty/scaladoc-empty-test/build.sbt similarity index 100% rename from sbt-dotty/sbt-test/sbt-dotty/scala3doc-empty-test/build.sbt rename to sbt-dotty/sbt-test/sbt-dotty/scaladoc-empty-test/build.sbt diff --git a/sbt-dotty/sbt-test/sbt-dotty/scala3doc-empty-test/project/plugins.sbt b/sbt-dotty/sbt-test/sbt-dotty/scaladoc-empty-test/project/plugins.sbt similarity index 100% rename from sbt-dotty/sbt-test/sbt-dotty/scala3doc-empty-test/project/plugins.sbt rename to sbt-dotty/sbt-test/sbt-dotty/scaladoc-empty-test/project/plugins.sbt diff --git a/sbt-dotty/sbt-test/sbt-dotty/scala3doc-empty-test/src/main/scala/hello/Hello.scala b/sbt-dotty/sbt-test/sbt-dotty/scaladoc-empty-test/src/main/scala/hello/Hello.scala similarity index 100% rename from sbt-dotty/sbt-test/sbt-dotty/scala3doc-empty-test/src/main/scala/hello/Hello.scala rename to sbt-dotty/sbt-test/sbt-dotty/scaladoc-empty-test/src/main/scala/hello/Hello.scala diff --git a/sbt-dotty/sbt-test/sbt-dotty/scala3doc-empty-test/test b/sbt-dotty/sbt-test/sbt-dotty/scaladoc-empty-test/test similarity index 100% rename from sbt-dotty/sbt-test/sbt-dotty/scala3doc-empty-test/test rename to sbt-dotty/sbt-test/sbt-dotty/scaladoc-empty-test/test diff --git a/sbt-dotty/sbt-test/sbt-dotty/scaladoc/build.sbt b/sbt-dotty/sbt-test/sbt-dotty/scaladoc/build.sbt new file mode 100644 index 000000000000..0e62a58c97a7 --- /dev/null +++ b/sbt-dotty/sbt-test/sbt-dotty/scaladoc/build.sbt @@ -0,0 +1,7 @@ +scalaVersion := sys.props("plugin.scalaVersion") + +lazy val assertUsingscaladoc = taskKey[Unit]("") + +assertUsingscaladoc := { + assert(usescaladoc.value) +} diff --git a/sbt-dotty/sbt-test/sbt-dotty/scala3doc/project/plugins.sbt b/sbt-dotty/sbt-test/sbt-dotty/scaladoc/project/plugins.sbt similarity index 100% rename from sbt-dotty/sbt-test/sbt-dotty/scala3doc/project/plugins.sbt rename to sbt-dotty/sbt-test/sbt-dotty/scaladoc/project/plugins.sbt diff --git a/sbt-dotty/sbt-test/sbt-dotty/scala3doc/src/main/scala/AutoParamTupling.scala b/sbt-dotty/sbt-test/sbt-dotty/scaladoc/src/main/scala/AutoParamTupling.scala similarity index 100% rename from sbt-dotty/sbt-test/sbt-dotty/scala3doc/src/main/scala/AutoParamTupling.scala rename to sbt-dotty/sbt-test/sbt-dotty/scaladoc/src/main/scala/AutoParamTupling.scala diff --git a/sbt-dotty/sbt-test/sbt-dotty/scala3doc/src/main/scala/ContextQueries.scala b/sbt-dotty/sbt-test/sbt-dotty/scaladoc/src/main/scala/ContextQueries.scala similarity index 100% rename from sbt-dotty/sbt-test/sbt-dotty/scala3doc/src/main/scala/ContextQueries.scala rename to sbt-dotty/sbt-test/sbt-dotty/scaladoc/src/main/scala/ContextQueries.scala diff --git a/sbt-dotty/sbt-test/sbt-dotty/scala3doc/src/main/scala/Conversion.scala b/sbt-dotty/sbt-test/sbt-dotty/scaladoc/src/main/scala/Conversion.scala similarity index 100% rename from sbt-dotty/sbt-test/sbt-dotty/scala3doc/src/main/scala/Conversion.scala rename to sbt-dotty/sbt-test/sbt-dotty/scaladoc/src/main/scala/Conversion.scala diff --git a/sbt-dotty/sbt-test/sbt-dotty/scala3doc/src/main/scala/EnumTypes.scala b/sbt-dotty/sbt-test/sbt-dotty/scaladoc/src/main/scala/EnumTypes.scala similarity index 100% rename from sbt-dotty/sbt-test/sbt-dotty/scala3doc/src/main/scala/EnumTypes.scala rename to sbt-dotty/sbt-test/sbt-dotty/scaladoc/src/main/scala/EnumTypes.scala diff --git a/sbt-dotty/sbt-test/sbt-dotty/scala3doc/src/main/scala/ImpliedInstances.scala b/sbt-dotty/sbt-test/sbt-dotty/scaladoc/src/main/scala/ImpliedInstances.scala similarity index 100% rename from sbt-dotty/sbt-test/sbt-dotty/scala3doc/src/main/scala/ImpliedInstances.scala rename to sbt-dotty/sbt-test/sbt-dotty/scaladoc/src/main/scala/ImpliedInstances.scala diff --git a/sbt-dotty/sbt-test/sbt-dotty/scala3doc/src/main/scala/IntersectionTypes.scala b/sbt-dotty/sbt-test/sbt-dotty/scaladoc/src/main/scala/IntersectionTypes.scala similarity index 100% rename from sbt-dotty/sbt-test/sbt-dotty/scala3doc/src/main/scala/IntersectionTypes.scala rename to sbt-dotty/sbt-test/sbt-dotty/scaladoc/src/main/scala/IntersectionTypes.scala diff --git a/sbt-dotty/sbt-test/sbt-dotty/scala3doc/src/main/scala/Main.scala b/sbt-dotty/sbt-test/sbt-dotty/scaladoc/src/main/scala/Main.scala similarity index 100% rename from sbt-dotty/sbt-test/sbt-dotty/scala3doc/src/main/scala/Main.scala rename to sbt-dotty/sbt-test/sbt-dotty/scaladoc/src/main/scala/Main.scala diff --git a/sbt-dotty/sbt-test/sbt-dotty/scala3doc/src/main/scala/MultiversalEquality.scala b/sbt-dotty/sbt-test/sbt-dotty/scaladoc/src/main/scala/MultiversalEquality.scala similarity index 100% rename from sbt-dotty/sbt-test/sbt-dotty/scala3doc/src/main/scala/MultiversalEquality.scala rename to sbt-dotty/sbt-test/sbt-dotty/scaladoc/src/main/scala/MultiversalEquality.scala diff --git a/sbt-dotty/sbt-test/sbt-dotty/scala3doc/src/main/scala/PatternMatching.scala b/sbt-dotty/sbt-test/sbt-dotty/scaladoc/src/main/scala/PatternMatching.scala similarity index 100% rename from sbt-dotty/sbt-test/sbt-dotty/scala3doc/src/main/scala/PatternMatching.scala rename to sbt-dotty/sbt-test/sbt-dotty/scaladoc/src/main/scala/PatternMatching.scala diff --git a/sbt-dotty/sbt-test/sbt-dotty/scala3doc/src/main/scala/StructuralTypes.scala b/sbt-dotty/sbt-test/sbt-dotty/scaladoc/src/main/scala/StructuralTypes.scala similarity index 100% rename from sbt-dotty/sbt-test/sbt-dotty/scala3doc/src/main/scala/StructuralTypes.scala rename to sbt-dotty/sbt-test/sbt-dotty/scaladoc/src/main/scala/StructuralTypes.scala diff --git a/sbt-dotty/sbt-test/sbt-dotty/scala3doc/src/main/scala/TraitParams.scala b/sbt-dotty/sbt-test/sbt-dotty/scaladoc/src/main/scala/TraitParams.scala similarity index 100% rename from sbt-dotty/sbt-test/sbt-dotty/scala3doc/src/main/scala/TraitParams.scala rename to sbt-dotty/sbt-test/sbt-dotty/scaladoc/src/main/scala/TraitParams.scala diff --git a/sbt-dotty/sbt-test/sbt-dotty/scala3doc/src/main/scala/TypeLambdas.scala b/sbt-dotty/sbt-test/sbt-dotty/scaladoc/src/main/scala/TypeLambdas.scala similarity index 100% rename from sbt-dotty/sbt-test/sbt-dotty/scala3doc/src/main/scala/TypeLambdas.scala rename to sbt-dotty/sbt-test/sbt-dotty/scaladoc/src/main/scala/TypeLambdas.scala diff --git a/sbt-dotty/sbt-test/sbt-dotty/scala3doc/src/main/scala/UnionTypes.scala b/sbt-dotty/sbt-test/sbt-dotty/scaladoc/src/main/scala/UnionTypes.scala similarity index 100% rename from sbt-dotty/sbt-test/sbt-dotty/scala3doc/src/main/scala/UnionTypes.scala rename to sbt-dotty/sbt-test/sbt-dotty/scaladoc/src/main/scala/UnionTypes.scala diff --git a/sbt-dotty/sbt-test/sbt-dotty/scala3doc/src/main/scala/hello/Hello.scala b/sbt-dotty/sbt-test/sbt-dotty/scaladoc/src/main/scala/hello/Hello.scala similarity index 100% rename from sbt-dotty/sbt-test/sbt-dotty/scala3doc/src/main/scala/hello/Hello.scala rename to sbt-dotty/sbt-test/sbt-dotty/scaladoc/src/main/scala/hello/Hello.scala diff --git a/sbt-dotty/sbt-test/sbt-dotty/scaladoc/test b/sbt-dotty/sbt-test/sbt-dotty/scaladoc/test new file mode 100644 index 000000000000..ea79f0b981ca --- /dev/null +++ b/sbt-dotty/sbt-test/sbt-dotty/scaladoc/test @@ -0,0 +1,3 @@ +> assertUsingscaladoc +> doc + diff --git a/sbt-dotty/src/dotty/tools/sbtplugin/DottyPlugin.scala b/sbt-dotty/src/dotty/tools/sbtplugin/DottyPlugin.scala index de6b83a2f654..54061840f12c 100644 --- a/sbt-dotty/src/dotty/tools/sbtplugin/DottyPlugin.scala +++ b/sbt-dotty/src/dotty/tools/sbtplugin/DottyPlugin.scala @@ -23,7 +23,7 @@ object DottyPlugin extends AutoPlugin { val isDotty = settingKey[Boolean]("Is this project compiled with Dotty?") val isDottyJS = settingKey[Boolean]("Is this project compiled with Dotty and Scala.js?") - val useScala3doc = settingKey[Boolean]("Use Scala3doc as the documentation tool") + val usescaladoc = settingKey[Boolean]("Use scaladoc as the documentation tool") val tastyFiles = taskKey[Seq[File]]("List all testy files") // NOTE: @@ -370,16 +370,16 @@ object DottyPlugin extends AutoPlugin { }.value, // Configuration for the doctool - resolvers ++= (if(!useScala3doc.value) Nil else Seq(Resolver.jcenterRepo)), - useScala3doc := { + resolvers ++= (if(!usescaladoc.value) Nil else Seq(Resolver.jcenterRepo)), + usescaladoc := { val v = scalaVersion.value v.startsWith("3.0.0") && !v.startsWith("3.0.0-M1") && !v.startsWith("3.0.0-M2") }, // We need to add doctool classes to the classpath so they can be called scalaInstance in doc := Def.taskDyn { if (isDotty.value) - if (useScala3doc.value) - dottyScalaInstanceTask("scala3doc") + if (usescaladoc.value) + dottyScalaInstanceTask("scaladoc") else dottyScalaInstanceTask(scala3Artefact(scalaVersion.value, "doc")) else @@ -455,7 +455,7 @@ object DottyPlugin extends AutoPlugin { }, sources := Def.taskDyn[Seq[File]] { val originalSources = sources.value - if (isDotty.value && useScala3doc.value && originalSources.nonEmpty) + if (isDotty.value && usescaladoc.value && originalSources.nonEmpty) Def.task { tastyFiles.value } else Def.task { originalSources } }.value, diff --git a/scala3doc/documentation/docs/design.md b/scala3doc/documentation/docs/design.md deleted file mode 100644 index cbcb40282faf..000000000000 --- a/scala3doc/documentation/docs/design.md +++ /dev/null @@ -1,7 +0,0 @@ -# Design of scala3doc - -**BEWARE this is not complete documentation yet but rather a draft mainly to test linking from static site to code** - -## Interface - -Scala3doc 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]]. \ No newline at end of file diff --git a/scala3doc-js/resources/scala3doc-searchbar.css b/scaladoc-js/resources/scaladoc-searchbar.css similarity index 79% rename from scala3doc-js/resources/scala3doc-searchbar.css rename to scaladoc-js/resources/scaladoc-searchbar.css index accc9cae1a69..4aaaacb98288 100644 --- a/scala3doc-js/resources/scala3doc-searchbar.css +++ b/scaladoc-js/resources/scaladoc-searchbar.css @@ -27,7 +27,7 @@ } } -#scala3doc-search { +#scaladoc-search { margin-top: 10px; cursor: pointer; position: fixed; @@ -36,11 +36,11 @@ z-index: 5; } -#scala3doc-searchbar.hidden { +#scaladoc-searchbar.hidden { display: none; } -#scala3doc-searchbar { +#scaladoc-searchbar { position: absolute; top: 50px; right: 40px; @@ -50,7 +50,7 @@ font-family: system-ui, -apple-system, Segoe UI, Roboto, Noto Sans, Ubuntu, Cantarell, Helvetica Neue, Arial, sans-serif; } -#scala3doc-searchbar-input { +#scaladoc-searchbar-input { width: 100%; min-height: 32px; border: none; @@ -58,11 +58,11 @@ padding: 10px; } -#scala3doc-searchbar-input:focus { +#scaladoc-searchbar-input:focus { outline: none; } -#scala3doc-searchbar-results { +#scaladoc-searchbar-results { background: white; display: flex; flex-direction: column; @@ -70,25 +70,25 @@ overflow: auto; } -.scala3doc-searchbar-result { +.scaladoc-searchbar-result { line-height: 32px; padding-left: 10px; padding-right: 10px; } -.scala3doc-searchbar-result:first-of-type { +.scaladoc-searchbar-result:first-of-type { margin-top: 10px; } -.scala3doc-searchbar-result:hover { +.scaladoc-searchbar-result:hover { background-color: #d4edff; } -.scala3doc-searchbar-result a { +.scaladoc-searchbar-result a { color: #1f2326; } -.scala3doc-searchbar-result .scala3doc-searchbar-location { +.scaladoc-searchbar-result .scaladoc-searchbar-location { color: gray; } diff --git a/scala3doc-js/src/Globals.scala b/scaladoc-js/src/Globals.scala similarity index 100% rename from scala3doc-js/src/Globals.scala rename to scaladoc-js/src/Globals.scala diff --git a/scala3doc-js/src/Main.scala b/scaladoc-js/src/Main.scala similarity index 100% rename from scala3doc-js/src/Main.scala rename to scaladoc-js/src/Main.scala diff --git a/scala3doc-js/src/searchbar/PageEntry.scala b/scaladoc-js/src/searchbar/PageEntry.scala similarity index 100% rename from scala3doc-js/src/searchbar/PageEntry.scala rename to scaladoc-js/src/searchbar/PageEntry.scala diff --git a/scala3doc-js/src/searchbar/Searchbar.scala b/scaladoc-js/src/searchbar/Searchbar.scala similarity index 100% rename from scala3doc-js/src/searchbar/Searchbar.scala rename to scaladoc-js/src/searchbar/Searchbar.scala diff --git a/scala3doc-js/src/searchbar/SearchbarComponent.scala b/scaladoc-js/src/searchbar/SearchbarComponent.scala similarity index 90% rename from scala3doc-js/src/searchbar/SearchbarComponent.scala rename to scaladoc-js/src/searchbar/SearchbarComponent.scala index e247ddab862f..3cf0272a012d 100644 --- a/scala3doc-js/src/searchbar/SearchbarComponent.scala +++ b/scaladoc-js/src/searchbar/SearchbarComponent.scala @@ -8,7 +8,7 @@ class SearchbarComponent(val callback: (String) => List[PageEntry]): extension (p: PageEntry) def toHTML = val wrapper = document.createElement("div").asInstanceOf[html.Div] - wrapper.classList.add("scala3doc-searchbar-result") + wrapper.classList.add("scaladoc-searchbar-result") wrapper.classList.add("monospace") val resultA = document.createElement("a").asInstanceOf[html.Anchor] @@ -17,7 +17,7 @@ class SearchbarComponent(val callback: (String) => List[PageEntry]): val location = document.createElement("span") location.classList.add("pull-right") - location.classList.add("scala3doc-searchbar-location") + location.classList.add("scaladoc-searchbar-location") location.textContent = p.description wrapper.appendChild(resultA) @@ -47,7 +47,7 @@ class SearchbarComponent(val callback: (String) => List[PageEntry]): private val searchIcon: html.Div = val span = document.createElement("span").asInstanceOf[html.Span] span.innerHTML = """""" - span.id = "scala3doc-search" + span.id = "scaladoc-search" span.onclick = (event: Event) => if (document.body.contains(rootDiv)) { document.body.removeChild(rootDiv) @@ -61,19 +61,19 @@ class SearchbarComponent(val callback: (String) => List[PageEntry]): ) ) ) - document.getElementById("scala3doc-searchBar").appendChild(element) + document.getElementById("scaladoc-searchBar").appendChild(element) element private val input: html.Input = val element = document.createElement("input").asInstanceOf[html.Input] - element.id = "scala3doc-searchbar-input" + element.id = "scaladoc-searchbar-input" element.addEventListener("input", (e) => handleNewQuery(e.target.asInstanceOf[html.Input].value)) element private val resultsDiv: html.Div = val element = document.createElement("div").asInstanceOf[html.Div] - element.id = "scala3doc-searchbar-results" + element.id = "scaladoc-searchbar-results" element private val rootHiddenClasses = "hidden" @@ -94,7 +94,7 @@ class SearchbarComponent(val callback: (String) => List[PageEntry]): document.body.removeChild(element) } ) - element.id = "scala3doc-searchbar" + element.id = "scaladoc-searchbar" element.appendChild(input) element.appendChild(resultsDiv) element diff --git a/scala3doc-js/src/searchbar/SearchbarGlobals.scala b/scaladoc-js/src/searchbar/SearchbarGlobals.scala similarity index 100% rename from scala3doc-js/src/searchbar/SearchbarGlobals.scala rename to scaladoc-js/src/searchbar/SearchbarGlobals.scala diff --git a/scala3doc-js/src/searchbar/engine/Matchers.scala b/scaladoc-js/src/searchbar/engine/Matchers.scala similarity index 100% rename from scala3doc-js/src/searchbar/engine/Matchers.scala rename to scaladoc-js/src/searchbar/engine/Matchers.scala diff --git a/scala3doc-js/src/searchbar/engine/QueryParser.scala b/scaladoc-js/src/searchbar/engine/QueryParser.scala similarity index 100% rename from scala3doc-js/src/searchbar/engine/QueryParser.scala rename to scaladoc-js/src/searchbar/engine/QueryParser.scala diff --git a/scala3doc-js/src/searchbar/engine/SearchbarEngine.scala b/scaladoc-js/src/searchbar/engine/SearchbarEngine.scala similarity index 100% rename from scala3doc-js/src/searchbar/engine/SearchbarEngine.scala rename to scaladoc-js/src/searchbar/engine/SearchbarEngine.scala diff --git a/scala3doc-testcases/src/example/Documentation2.scala b/scaladoc-testcases/src/example/Documentation2.scala similarity index 100% rename from scala3doc-testcases/src/example/Documentation2.scala rename to scaladoc-testcases/src/example/Documentation2.scala diff --git a/scala3doc-testcases/src/example/Inheritance.scala b/scaladoc-testcases/src/example/Inheritance.scala similarity index 100% rename from scala3doc-testcases/src/example/Inheritance.scala rename to scaladoc-testcases/src/example/Inheritance.scala diff --git a/scala3doc-testcases/src/example/level2/Documentation.scala b/scaladoc-testcases/src/example/level2/Documentation.scala similarity index 100% rename from scala3doc-testcases/src/example/level2/Documentation.scala rename to scaladoc-testcases/src/example/level2/Documentation.scala diff --git a/scala3doc-testcases/src/example/level2/SameLevelTypeLinking.scala b/scaladoc-testcases/src/example/level2/SameLevelTypeLinking.scala similarity index 100% rename from scala3doc-testcases/src/example/level2/SameLevelTypeLinking.scala rename to scaladoc-testcases/src/example/level2/SameLevelTypeLinking.scala diff --git a/scala3doc-testcases/src/example/level2/level3/level4/ClassLevel4.scala b/scaladoc-testcases/src/example/level2/level3/level4/ClassLevel4.scala similarity index 100% rename from scala3doc-testcases/src/example/level2/level3/level4/ClassLevel4.scala rename to scaladoc-testcases/src/example/level2/level3/level4/ClassLevel4.scala diff --git a/scala3doc-testcases/src/example/typeAndObjects/binaryops.scala b/scaladoc-testcases/src/example/typeAndObjects/binaryops.scala similarity index 100% rename from scala3doc-testcases/src/example/typeAndObjects/binaryops.scala rename to scaladoc-testcases/src/example/typeAndObjects/binaryops.scala diff --git a/scala3doc-testcases/src/example/typeAndObjects/package.scala b/scaladoc-testcases/src/example/typeAndObjects/package.scala similarity index 100% rename from scala3doc-testcases/src/example/typeAndObjects/package.scala rename to scaladoc-testcases/src/example/typeAndObjects/package.scala diff --git a/scala3doc-testcases/src/tests/FilterTest.scala b/scaladoc-testcases/src/tests/FilterTest.scala similarity index 100% rename from scala3doc-testcases/src/tests/FilterTest.scala rename to scaladoc-testcases/src/tests/FilterTest.scala diff --git a/scala3doc-testcases/src/tests/annotations.scala b/scaladoc-testcases/src/tests/annotations.scala similarity index 100% rename from scala3doc-testcases/src/tests/annotations.scala rename to scaladoc-testcases/src/tests/annotations.scala diff --git a/scala3doc-testcases/src/tests/annotationsExample.scala b/scaladoc-testcases/src/tests/annotationsExample.scala similarity index 100% rename from scala3doc-testcases/src/tests/annotationsExample.scala rename to scaladoc-testcases/src/tests/annotationsExample.scala diff --git a/scala3doc-testcases/src/tests/classModifiers.scala b/scaladoc-testcases/src/tests/classModifiers.scala similarity index 100% rename from scala3doc-testcases/src/tests/classModifiers.scala rename to scaladoc-testcases/src/tests/classModifiers.scala diff --git a/scala3doc-testcases/src/tests/classSignatureTestSource.scala b/scaladoc-testcases/src/tests/classSignatureTestSource.scala similarity index 100% rename from scala3doc-testcases/src/tests/classSignatureTestSource.scala rename to scaladoc-testcases/src/tests/classSignatureTestSource.scala diff --git a/scala3doc-testcases/src/tests/companionObjectSignatures.scala b/scaladoc-testcases/src/tests/companionObjectSignatures.scala similarity index 100% rename from scala3doc-testcases/src/tests/companionObjectSignatures.scala rename to scaladoc-testcases/src/tests/companionObjectSignatures.scala diff --git a/scala3doc-testcases/src/tests/complexNames.scala b/scaladoc-testcases/src/tests/complexNames.scala similarity index 93% rename from scala3doc-testcases/src/tests/complexNames.scala rename to scaladoc-testcases/src/tests/complexNames.scala index df0e515d497d..92c0abc319af 100644 --- a/scala3doc-testcases/src/tests/complexNames.scala +++ b/scaladoc-testcases/src/tests/complexNames.scala @@ -7,7 +7,7 @@ abstract class A: def +:(other: Int): A def :+(other: Int): A - // scala3doc has problems with names in backticks + // scaladoc has problems with names in backticks // def `multi word name`: Int // def `*** name with arbitrary chars ^%`: Int // def `mischievous(param:Int)`(otherParam: Int): String diff --git a/scala3doc-testcases/src/tests/deprecated.scala b/scaladoc-testcases/src/tests/deprecated.scala similarity index 100% rename from scala3doc-testcases/src/tests/deprecated.scala rename to scaladoc-testcases/src/tests/deprecated.scala diff --git a/scala3doc-testcases/src/tests/docString.scala b/scaladoc-testcases/src/tests/docString.scala similarity index 100% rename from scala3doc-testcases/src/tests/docString.scala rename to scaladoc-testcases/src/tests/docString.scala diff --git a/scala3doc-testcases/src/tests/enumSignatures.scala b/scaladoc-testcases/src/tests/enumSignatures.scala similarity index 100% rename from scala3doc-testcases/src/tests/enumSignatures.scala rename to scaladoc-testcases/src/tests/enumSignatures.scala diff --git a/scala3doc-testcases/src/tests/exports.scala b/scaladoc-testcases/src/tests/exports.scala similarity index 100% rename from scala3doc-testcases/src/tests/exports.scala rename to scaladoc-testcases/src/tests/exports.scala diff --git a/scala3doc-testcases/src/tests/extensionDRIs.scala b/scaladoc-testcases/src/tests/extensionDRIs.scala similarity index 100% rename from scala3doc-testcases/src/tests/extensionDRIs.scala rename to scaladoc-testcases/src/tests/extensionDRIs.scala diff --git a/scala3doc-testcases/src/tests/extensionMethodSignatures.scala b/scaladoc-testcases/src/tests/extensionMethodSignatures.scala similarity index 100% rename from scala3doc-testcases/src/tests/extensionMethodSignatures.scala rename to scaladoc-testcases/src/tests/extensionMethodSignatures.scala diff --git a/scala3doc-testcases/src/tests/externalLocations/javadoc.scala b/scaladoc-testcases/src/tests/externalLocations/javadoc.scala similarity index 100% rename from scala3doc-testcases/src/tests/externalLocations/javadoc.scala rename to scaladoc-testcases/src/tests/externalLocations/javadoc.scala diff --git a/scala3doc-testcases/src/tests/externalLocations/scala3doc.scala b/scaladoc-testcases/src/tests/externalLocations/scaladoc2.scala similarity index 80% rename from scala3doc-testcases/src/tests/externalLocations/scala3doc.scala rename to scaladoc-testcases/src/tests/externalLocations/scaladoc2.scala index abf0b176183e..25f19b4f637e 100644 --- a/scala3doc-testcases/src/tests/externalLocations/scala3doc.scala +++ b/scaladoc-testcases/src/tests/externalLocations/scaladoc2.scala @@ -1,4 +1,4 @@ -package tests.externalScala3doc +package tests.externalScaladoc2 import scala.util.matching._ diff --git a/scala3doc-testcases/src/tests/externalLocations/scaladoc.scala b/scaladoc-testcases/src/tests/externalLocations/scaladoc3.scala similarity index 80% rename from scala3doc-testcases/src/tests/externalLocations/scaladoc.scala rename to scaladoc-testcases/src/tests/externalLocations/scaladoc3.scala index bf91b0f296c0..43e7d9e14adb 100644 --- a/scala3doc-testcases/src/tests/externalLocations/scaladoc.scala +++ b/scaladoc-testcases/src/tests/externalLocations/scaladoc3.scala @@ -1,4 +1,4 @@ -package tests.externalScaladoc +package tests.externalScaladoc3 import scala.util.matching._ diff --git a/scala3doc-testcases/src/tests/fieldsSignatures.scala b/scaladoc-testcases/src/tests/fieldsSignatures.scala similarity index 100% rename from scala3doc-testcases/src/tests/fieldsSignatures.scala rename to scaladoc-testcases/src/tests/fieldsSignatures.scala diff --git a/scala3doc-testcases/src/tests/functionDRI.scala b/scaladoc-testcases/src/tests/functionDRI.scala similarity index 91% rename from scala3doc-testcases/src/tests/functionDRI.scala rename to scaladoc-testcases/src/tests/functionDRI.scala index b1df71f2caef..2407498e8b86 100644 --- a/scala3doc-testcases/src/tests/functionDRI.scala +++ b/scaladoc-testcases/src/tests/functionDRI.scala @@ -10,7 +10,7 @@ def a(as: Seq[A]) = 1 def a(a: A) = 2 def b(b: B) = 3 -// scala3doc right now is ignroing @targetName +// scaladoc right now is ignroing @targetName // def b(a: A, b: B) = 4 // @targetName("b2") def b(a: A)(b: B) = 5 diff --git a/scala3doc-testcases/src/tests/genericDRI.scala b/scaladoc-testcases/src/tests/genericDRI.scala similarity index 100% rename from scala3doc-testcases/src/tests/genericDRI.scala rename to scaladoc-testcases/src/tests/genericDRI.scala diff --git a/scala3doc-testcases/src/tests/genericMethods.scala b/scaladoc-testcases/src/tests/genericMethods.scala similarity index 100% rename from scala3doc-testcases/src/tests/genericMethods.scala rename to scaladoc-testcases/src/tests/genericMethods.scala diff --git a/scala3doc-testcases/src/tests/genericSignatures.scala b/scaladoc-testcases/src/tests/genericSignatures.scala similarity index 100% rename from scala3doc-testcases/src/tests/genericSignatures.scala rename to scaladoc-testcases/src/tests/genericSignatures.scala diff --git a/scala3doc-testcases/src/tests/givenDRI.scala b/scaladoc-testcases/src/tests/givenDRI.scala similarity index 100% rename from scala3doc-testcases/src/tests/givenDRI.scala rename to scaladoc-testcases/src/tests/givenDRI.scala diff --git a/scala3doc-testcases/src/tests/givenSignatures.scala b/scaladoc-testcases/src/tests/givenSignatures.scala similarity index 100% rename from scala3doc-testcases/src/tests/givenSignatures.scala rename to scaladoc-testcases/src/tests/givenSignatures.scala diff --git a/scala3doc-testcases/src/tests/givenSignaturesPg.scala b/scaladoc-testcases/src/tests/givenSignaturesPg.scala similarity index 100% rename from scala3doc-testcases/src/tests/givenSignaturesPg.scala rename to scaladoc-testcases/src/tests/givenSignaturesPg.scala diff --git a/scala3doc-testcases/src/tests/hierarchy.scala b/scaladoc-testcases/src/tests/hierarchy.scala similarity index 100% rename from scala3doc-testcases/src/tests/hierarchy.scala rename to scaladoc-testcases/src/tests/hierarchy.scala diff --git a/scala3doc-testcases/src/tests/htmlTests.scala b/scaladoc-testcases/src/tests/htmlTests.scala similarity index 100% rename from scala3doc-testcases/src/tests/htmlTests.scala rename to scaladoc-testcases/src/tests/htmlTests.scala diff --git a/scala3doc-testcases/src/tests/implicitConversions.scala b/scaladoc-testcases/src/tests/implicitConversions.scala similarity index 100% rename from scala3doc-testcases/src/tests/implicitConversions.scala rename to scaladoc-testcases/src/tests/implicitConversions.scala diff --git a/scala3doc-testcases/src/tests/implicitConversions2.scala b/scaladoc-testcases/src/tests/implicitConversions2.scala similarity index 100% rename from scala3doc-testcases/src/tests/implicitConversions2.scala rename to scaladoc-testcases/src/tests/implicitConversions2.scala diff --git a/scala3doc-testcases/src/tests/implicitMembers.scala b/scaladoc-testcases/src/tests/implicitMembers.scala similarity index 100% rename from scala3doc-testcases/src/tests/implicitMembers.scala rename to scaladoc-testcases/src/tests/implicitMembers.scala diff --git a/scala3doc-testcases/src/tests/inheritanceLoop.scala b/scaladoc-testcases/src/tests/inheritanceLoop.scala similarity index 100% rename from scala3doc-testcases/src/tests/inheritanceLoop.scala rename to scaladoc-testcases/src/tests/inheritanceLoop.scala diff --git a/scala3doc-testcases/src/tests/inheritedMembers1.scala b/scaladoc-testcases/src/tests/inheritedMembers1.scala similarity index 100% rename from scala3doc-testcases/src/tests/inheritedMembers1.scala rename to scaladoc-testcases/src/tests/inheritedMembers1.scala diff --git a/scala3doc-testcases/src/tests/inheritedMembers2.scala b/scaladoc-testcases/src/tests/inheritedMembers2.scala similarity index 100% rename from scala3doc-testcases/src/tests/inheritedMembers2.scala rename to scaladoc-testcases/src/tests/inheritedMembers2.scala diff --git a/scala3doc-testcases/src/tests/links.scala b/scaladoc-testcases/src/tests/links.scala similarity index 100% rename from scala3doc-testcases/src/tests/links.scala rename to scaladoc-testcases/src/tests/links.scala diff --git a/scala3doc-testcases/src/tests/markdown-tests.scala b/scaladoc-testcases/src/tests/markdown-tests.scala similarity index 100% rename from scala3doc-testcases/src/tests/markdown-tests.scala rename to scaladoc-testcases/src/tests/markdown-tests.scala diff --git a/scala3doc-testcases/src/tests/mergedPackage1.scala b/scaladoc-testcases/src/tests/mergedPackage1.scala similarity index 100% rename from scala3doc-testcases/src/tests/mergedPackage1.scala rename to scaladoc-testcases/src/tests/mergedPackage1.scala diff --git a/scala3doc-testcases/src/tests/mergedPackage2.scala b/scaladoc-testcases/src/tests/mergedPackage2.scala similarity index 100% rename from scala3doc-testcases/src/tests/mergedPackage2.scala rename to scaladoc-testcases/src/tests/mergedPackage2.scala diff --git a/scala3doc-testcases/src/tests/mergedPackage3.scala b/scaladoc-testcases/src/tests/mergedPackage3.scala similarity index 100% rename from scala3doc-testcases/src/tests/mergedPackage3.scala rename to scaladoc-testcases/src/tests/mergedPackage3.scala diff --git a/scala3doc-testcases/src/tests/methodsAndConstructors.scala b/scaladoc-testcases/src/tests/methodsAndConstructors.scala similarity index 100% rename from scala3doc-testcases/src/tests/methodsAndConstructors.scala rename to scaladoc-testcases/src/tests/methodsAndConstructors.scala diff --git a/scala3doc-testcases/src/tests/modifiersSignatureTestSource.scala b/scaladoc-testcases/src/tests/modifiersSignatureTestSource.scala similarity index 100% rename from scala3doc-testcases/src/tests/modifiersSignatureTestSource.scala rename to scaladoc-testcases/src/tests/modifiersSignatureTestSource.scala diff --git a/scala3doc-testcases/src/tests/nested.scala b/scaladoc-testcases/src/tests/nested.scala similarity index 100% rename from scala3doc-testcases/src/tests/nested.scala rename to scaladoc-testcases/src/tests/nested.scala diff --git a/scala3doc-testcases/src/tests/nestingDRI.scala b/scaladoc-testcases/src/tests/nestingDRI.scala similarity index 100% rename from scala3doc-testcases/src/tests/nestingDRI.scala rename to scaladoc-testcases/src/tests/nestingDRI.scala diff --git a/scala3doc-testcases/src/tests/objectSignatures.scala b/scaladoc-testcases/src/tests/objectSignatures.scala similarity index 100% rename from scala3doc-testcases/src/tests/objectSignatures.scala rename to scaladoc-testcases/src/tests/objectSignatures.scala diff --git a/scala3doc-testcases/src/tests/opaqueTypes.scala b/scaladoc-testcases/src/tests/opaqueTypes.scala similarity index 100% rename from scala3doc-testcases/src/tests/opaqueTypes.scala rename to scaladoc-testcases/src/tests/opaqueTypes.scala diff --git a/scala3doc-testcases/src/tests/overrides.scala b/scaladoc-testcases/src/tests/overrides.scala similarity index 100% rename from scala3doc-testcases/src/tests/overrides.scala rename to scaladoc-testcases/src/tests/overrides.scala diff --git a/scala3doc-testcases/src/tests/package.scala b/scaladoc-testcases/src/tests/package.scala similarity index 100% rename from scala3doc-testcases/src/tests/package.scala rename to scaladoc-testcases/src/tests/package.scala diff --git a/scala3doc-testcases/src/tests/packageObjectSymbolSignatures.scala b/scaladoc-testcases/src/tests/packageObjectSymbolSignatures.scala similarity index 100% rename from scala3doc-testcases/src/tests/packageObjectSymbolSignatures.scala rename to scaladoc-testcases/src/tests/packageObjectSymbolSignatures.scala diff --git a/scala3doc-testcases/src/tests/packageSymbolSignatures.scala b/scaladoc-testcases/src/tests/packageSymbolSignatures.scala similarity index 100% rename from scala3doc-testcases/src/tests/packageSymbolSignatures.scala rename to scaladoc-testcases/src/tests/packageSymbolSignatures.scala diff --git a/scala3doc-testcases/src/tests/shadowingDRI.scala b/scaladoc-testcases/src/tests/shadowingDRI.scala similarity index 100% rename from scala3doc-testcases/src/tests/shadowingDRI.scala rename to scaladoc-testcases/src/tests/shadowingDRI.scala diff --git a/scala3doc-testcases/src/tests/signatureTestSource.scala b/scaladoc-testcases/src/tests/signatureTestSource.scala similarity index 100% rename from scala3doc-testcases/src/tests/signatureTestSource.scala rename to scaladoc-testcases/src/tests/signatureTestSource.scala diff --git a/scala3doc-testcases/src/tests/site.scala b/scaladoc-testcases/src/tests/site.scala similarity index 100% rename from scala3doc-testcases/src/tests/site.scala rename to scaladoc-testcases/src/tests/site.scala diff --git a/scala3doc-testcases/src/tests/specializedSignature.scala b/scaladoc-testcases/src/tests/specializedSignature.scala similarity index 100% rename from scala3doc-testcases/src/tests/specializedSignature.scala rename to scaladoc-testcases/src/tests/specializedSignature.scala diff --git a/scala3doc-testcases/src/tests/structuralTypes.scala b/scaladoc-testcases/src/tests/structuralTypes.scala similarity index 100% rename from scala3doc-testcases/src/tests/structuralTypes.scala rename to scaladoc-testcases/src/tests/structuralTypes.scala diff --git a/scala3doc-testcases/src/tests/tests.scala b/scaladoc-testcases/src/tests/tests.scala similarity index 100% rename from scala3doc-testcases/src/tests/tests.scala rename to scaladoc-testcases/src/tests/tests.scala diff --git a/scala3doc-testcases/src/tests/traitSignatures.scala b/scaladoc-testcases/src/tests/traitSignatures.scala similarity index 100% rename from scala3doc-testcases/src/tests/traitSignatures.scala rename to scaladoc-testcases/src/tests/traitSignatures.scala diff --git a/scala3doc-testcases/src/tests/typeAppliance.scala b/scaladoc-testcases/src/tests/typeAppliance.scala similarity index 100% rename from scala3doc-testcases/src/tests/typeAppliance.scala rename to scaladoc-testcases/src/tests/typeAppliance.scala diff --git a/scala3doc-testcases/src/tests/typeLambdas.scala b/scaladoc-testcases/src/tests/typeLambdas.scala similarity index 100% rename from scala3doc-testcases/src/tests/typeLambdas.scala rename to scaladoc-testcases/src/tests/typeLambdas.scala diff --git a/scala3doc-testcases/src/tests/typesSignatures.scala b/scaladoc-testcases/src/tests/typesSignatures.scala similarity index 100% rename from scala3doc-testcases/src/tests/typesSignatures.scala rename to scaladoc-testcases/src/tests/typesSignatures.scala diff --git a/scala3doc-testcases/src/tests/using.scala b/scaladoc-testcases/src/tests/using.scala similarity index 100% rename from scala3doc-testcases/src/tests/using.scala rename to scaladoc-testcases/src/tests/using.scala diff --git a/scala3doc-testcases/src/tests/visibility.scala b/scaladoc-testcases/src/tests/visibility.scala similarity index 100% rename from scala3doc-testcases/src/tests/visibility.scala rename to scaladoc-testcases/src/tests/visibility.scala diff --git a/scala3doc-testcases/src/tests/wiki-tests.scala b/scaladoc-testcases/src/tests/wiki-tests.scala similarity index 100% rename from scala3doc-testcases/src/tests/wiki-tests.scala rename to scaladoc-testcases/src/tests/wiki-tests.scala diff --git a/scala3doc-testcases/src/toplevel.scala b/scaladoc-testcases/src/toplevel.scala similarity index 100% rename from scala3doc-testcases/src/toplevel.scala rename to scaladoc-testcases/src/toplevel.scala diff --git a/scala3doc/.gitignore b/scaladoc/.gitignore similarity index 100% rename from scala3doc/.gitignore rename to scaladoc/.gitignore diff --git a/scala3doc/.scalafmt.conf b/scaladoc/.scalafmt.conf similarity index 100% rename from scala3doc/.scalafmt.conf rename to scaladoc/.scalafmt.conf diff --git a/scala3doc/README.md b/scaladoc/README.md similarity index 89% rename from scala3doc/README.md rename to scaladoc/README.md index 68cfc3dd7f9f..eae617c5f067 100644 --- a/scala3doc/README.md +++ b/scaladoc/README.md @@ -1,6 +1,6 @@ -# Scala3doc +# scaladoc -Scala3doc (name subject to change) is the documentation tool for +scaladoc (name subject to change) is the documentation tool for [Dotty](https://github.com/lampepfl/dotty), which is scheduled to become Scala 3. It uses the TastyInspector to access definitions, which is an officially supported way to access Dotty's perspective of a @@ -12,15 +12,15 @@ We're aiming to support all the features Scaladoc did, plus new and exciting one - displaying project and API documentation together on one site! - and more! -**Yes, this page was generated using scala3doc** +**Yes, this page was generated using scaladoc** ## Running the project Use the following commands to generate documentation for this project and for Dotty, respectively: ``` -sbt scala3doc/generateSelfDocumentation -sbt scala3doc/generateScala3Documentation +sbt scaladoc/generateSelfDocumentation +sbt scaladoc/generatescaladocumentation ``` To actually view the documentation, the easiest way is to run the following in project root: @@ -46,7 +46,7 @@ CLI command for running our tool is in form: `sbt main -n -o -t - ``: is list of dirs or jars that contains tasty files that should be documented - ``: classpath that was used to generate tasty files - ``: links to source files of module that are used to link symbols on pages to their source file. They need to be supplied in form: - `local_dir=remote_dir#line_suffix` e.g. `src/main/scala=https://github.com/lampepfl/scala3doc/tree/master/src/main/scala#L` + `local_dir=remote_dir#line_suffix` e.g. `src/main/scala=https://github.com/lampepfl/scaladoc/tree/master/src/main/scala#L` - ``: directory of static documentation that you would like to render with API documentation. ## Developing @@ -54,21 +54,21 @@ CLI command for running our tool is in form: `sbt main -n -o -t At least two of our contributors use [Metals](https://scalameta.org/metals/) to work on the project. -For every PR, we build documentation for Scala3doc and Dotty. For example, for +For every PR, we build documentation for scaladoc and Dotty. For example, for PR 123 you can find them at: -- -- -- +- +- +- Note that these correspond to the contents of `output` directory - that's precisely what they are. You can also find the result of building the same sites for latest `master` at: -- -- -- +- +- +- ### Testing diff --git a/scaladoc/documentation/docs/design.md b/scaladoc/documentation/docs/design.md new file mode 100644 index 000000000000..477b2849cbf7 --- /dev/null +++ b/scaladoc/documentation/docs/design.md @@ -0,0 +1,7 @@ +# Design of scaladoc + +**BEWARE this is not complete documentation yet but rather a draft mainly to test linking from static site to code** + +## 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]]. \ No newline at end of file diff --git a/scala3doc/documentation/docs/index.md b/scaladoc/documentation/docs/index.md similarity index 100% rename from scala3doc/documentation/docs/index.md rename to scaladoc/documentation/docs/index.md diff --git a/scala3doc/documentation/index.md b/scaladoc/documentation/index.md similarity index 100% rename from scala3doc/documentation/index.md rename to scaladoc/documentation/index.md diff --git a/scala3doc/documentation/logo.svg b/scaladoc/documentation/logo.svg similarity index 100% rename from scala3doc/documentation/logo.svg rename to scaladoc/documentation/logo.svg diff --git a/scala3doc/e2e/.prettierrc b/scaladoc/e2e/.prettierrc similarity index 100% rename from scala3doc/e2e/.prettierrc rename to scaladoc/e2e/.prettierrc diff --git a/scala3doc/e2e/README.md b/scaladoc/e2e/README.md similarity index 71% rename from scala3doc/e2e/README.md rename to scaladoc/e2e/README.md index 61b4b59fb2af..2851a079cbb0 100644 --- a/scala3doc/e2e/README.md +++ b/scaladoc/e2e/README.md @@ -1,4 +1,4 @@ -## scala3doc e2e test suite +## scaladoc e2e test suite ### Prerequisites @@ -7,6 +7,6 @@ ### Running tests -- generate the test docs: `sbt scala3doc/generateTestcasesDocumentation` +- generate the test docs: `sbt scaladoc/generateTestcasesDocumentation` - run the web server in the `output` directory: `python3 -m http.server 8080` - run `npm run cypress:open` to see the cypress UI or `npm run cypress:run` to run tests heedlessly diff --git a/scala3doc/e2e/cypress.json b/scaladoc/e2e/cypress.json similarity index 100% rename from scala3doc/e2e/cypress.json rename to scaladoc/e2e/cypress.json diff --git a/scala3doc/e2e/cypress/integration/filter-bar.spec.ts b/scaladoc/e2e/cypress/integration/filter-bar.spec.ts similarity index 100% rename from scala3doc/e2e/cypress/integration/filter-bar.spec.ts rename to scaladoc/e2e/cypress/integration/filter-bar.spec.ts diff --git a/scala3doc/e2e/cypress/support/commands.ts b/scaladoc/e2e/cypress/support/commands.ts similarity index 100% rename from scala3doc/e2e/cypress/support/commands.ts rename to scaladoc/e2e/cypress/support/commands.ts diff --git a/scala3doc/e2e/cypress/support/index.ts b/scaladoc/e2e/cypress/support/index.ts similarity index 100% rename from scala3doc/e2e/cypress/support/index.ts rename to scaladoc/e2e/cypress/support/index.ts diff --git a/scala3doc/e2e/package-lock.json b/scaladoc/e2e/package-lock.json similarity index 99% rename from scala3doc/e2e/package-lock.json rename to scaladoc/e2e/package-lock.json index 3f09b6e3afff..bcebfd932f1d 100644 --- a/scala3doc/e2e/package-lock.json +++ b/scaladoc/e2e/package-lock.json @@ -1,5 +1,5 @@ { - "name": "scala3doc-e2e", + "name": "scaladoc-e2e", "version": "1.0.0", "lockfileVersion": 1, "requires": true, diff --git a/scala3doc/e2e/package.json b/scaladoc/e2e/package.json similarity index 92% rename from scala3doc/e2e/package.json rename to scaladoc/e2e/package.json index 7f47fc7c86dc..8cd476a5e74c 100644 --- a/scala3doc/e2e/package.json +++ b/scaladoc/e2e/package.json @@ -1,5 +1,5 @@ { - "name": "scala3doc-e2e", + "name": "scaladoc-e2e", "version": "1.0.0", "description": "", "main": "index.js", diff --git a/scala3doc/e2e/tsconfig.json b/scaladoc/e2e/tsconfig.json similarity index 100% rename from scala3doc/e2e/tsconfig.json rename to scaladoc/e2e/tsconfig.json diff --git a/scala3doc/resources/dotty_res/favicon.ico b/scaladoc/resources/dotty_res/favicon.ico similarity index 100% rename from scala3doc/resources/dotty_res/favicon.ico rename to scaladoc/resources/dotty_res/favicon.ico diff --git a/scala3doc/resources/dotty_res/fonts/dotty-icons.ttf b/scaladoc/resources/dotty_res/fonts/dotty-icons.ttf similarity index 100% rename from scala3doc/resources/dotty_res/fonts/dotty-icons.ttf rename to scaladoc/resources/dotty_res/fonts/dotty-icons.ttf diff --git a/scala3doc/resources/dotty_res/fonts/dotty-icons.woff b/scaladoc/resources/dotty_res/fonts/dotty-icons.woff similarity index 100% rename from scala3doc/resources/dotty_res/fonts/dotty-icons.woff rename to scaladoc/resources/dotty_res/fonts/dotty-icons.woff diff --git a/scala3doc/resources/dotty_res/hljs/LICENSE b/scaladoc/resources/dotty_res/hljs/LICENSE similarity index 100% rename from scala3doc/resources/dotty_res/hljs/LICENSE rename to scaladoc/resources/dotty_res/hljs/LICENSE diff --git a/scala3doc/resources/dotty_res/hljs/highlight.pack.js b/scaladoc/resources/dotty_res/hljs/highlight.pack.js similarity index 100% rename from scala3doc/resources/dotty_res/hljs/highlight.pack.js rename to scaladoc/resources/dotty_res/hljs/highlight.pack.js diff --git a/scala3doc/resources/dotty_res/images/scala3doc_logo.svg b/scaladoc/resources/dotty_res/images/scaladoc_logo.svg similarity index 100% rename from scala3doc/resources/dotty_res/images/scala3doc_logo.svg rename to scaladoc/resources/dotty_res/images/scaladoc_logo.svg diff --git a/scala3doc/resources/dotty_res/scripts/common/component.js b/scaladoc/resources/dotty_res/scripts/common/component.js similarity index 100% rename from scala3doc/resources/dotty_res/scripts/common/component.js rename to scaladoc/resources/dotty_res/scripts/common/component.js diff --git a/scala3doc/resources/dotty_res/scripts/common/utils.js b/scaladoc/resources/dotty_res/scripts/common/utils.js similarity index 100% rename from scala3doc/resources/dotty_res/scripts/common/utils.js rename to scaladoc/resources/dotty_res/scripts/common/utils.js diff --git a/scala3doc/resources/dotty_res/scripts/components/DocumentableList.js b/scaladoc/resources/dotty_res/scripts/components/DocumentableList.js similarity index 100% rename from scala3doc/resources/dotty_res/scripts/components/DocumentableList.js rename to scaladoc/resources/dotty_res/scripts/components/DocumentableList.js diff --git a/scala3doc/resources/dotty_res/scripts/components/Filter.js b/scaladoc/resources/dotty_res/scripts/components/Filter.js similarity index 99% rename from scala3doc/resources/dotty_res/scripts/components/Filter.js rename to scaladoc/resources/dotty_res/scripts/components/Filter.js index 0b070792f8dc..fa30565210d2 100644 --- a/scala3doc/resources/dotty_res/scripts/components/Filter.js +++ b/scaladoc/resources/dotty_res/scripts/components/Filter.js @@ -19,7 +19,7 @@ class Filter { } static get defaultFilters() { - return scala3DocData.filterDefaults + return scaladocData.filterDefaults } get value() { diff --git a/scala3doc/resources/dotty_res/scripts/components/FilterBar.js b/scaladoc/resources/dotty_res/scripts/components/FilterBar.js similarity index 100% rename from scala3doc/resources/dotty_res/scripts/components/FilterBar.js rename to scaladoc/resources/dotty_res/scripts/components/FilterBar.js diff --git a/scala3doc/resources/dotty_res/scripts/components/FilterGroup.js b/scaladoc/resources/dotty_res/scripts/components/FilterGroup.js similarity index 100% rename from scala3doc/resources/dotty_res/scripts/components/FilterGroup.js rename to scaladoc/resources/dotty_res/scripts/components/FilterGroup.js diff --git a/scala3doc/resources/dotty_res/scripts/components/Input.js b/scaladoc/resources/dotty_res/scripts/components/Input.js similarity index 100% rename from scala3doc/resources/dotty_res/scripts/components/Input.js rename to scaladoc/resources/dotty_res/scripts/components/Input.js diff --git a/scala3doc/resources/dotty_res/scripts/diagram.js b/scaladoc/resources/dotty_res/scripts/diagram.js similarity index 100% rename from scala3doc/resources/dotty_res/scripts/diagram.js rename to scaladoc/resources/dotty_res/scripts/diagram.js diff --git a/scala3doc/resources/dotty_res/scripts/hljs-scala3.js b/scaladoc/resources/dotty_res/scripts/hljs-scala3.js similarity index 100% rename from scala3doc/resources/dotty_res/scripts/hljs-scala3.js rename to scaladoc/resources/dotty_res/scripts/hljs-scala3.js diff --git a/scala3doc/resources/dotty_res/scripts/ux.js b/scaladoc/resources/dotty_res/scripts/ux.js similarity index 100% rename from scala3doc/resources/dotty_res/scripts/ux.js rename to scaladoc/resources/dotty_res/scripts/ux.js diff --git a/scala3doc/resources/dotty_res/styles/diagram.css b/scaladoc/resources/dotty_res/styles/diagram.css similarity index 100% rename from scala3doc/resources/dotty_res/styles/diagram.css rename to scaladoc/resources/dotty_res/styles/diagram.css diff --git a/scala3doc/resources/dotty_res/styles/dotty-icons.css b/scaladoc/resources/dotty_res/styles/dotty-icons.css similarity index 100% rename from scala3doc/resources/dotty_res/styles/dotty-icons.css rename to scaladoc/resources/dotty_res/styles/dotty-icons.css diff --git a/scala3doc/resources/dotty_res/styles/filter-bar.css b/scaladoc/resources/dotty_res/styles/filter-bar.css similarity index 100% rename from scala3doc/resources/dotty_res/styles/filter-bar.css rename to scaladoc/resources/dotty_res/styles/filter-bar.css diff --git a/scala3doc/resources/dotty_res/styles/nord-light.css b/scaladoc/resources/dotty_res/styles/nord-light.css similarity index 100% rename from scala3doc/resources/dotty_res/styles/nord-light.css rename to scaladoc/resources/dotty_res/styles/nord-light.css diff --git a/scala3doc/resources/dotty_res/styles/scalastyle.css b/scaladoc/resources/dotty_res/styles/scalastyle.css similarity index 99% rename from scala3doc/resources/dotty_res/styles/scalastyle.css rename to scaladoc/resources/dotty_res/styles/scalastyle.css index b7417d7df9e9..353784b7a84b 100644 --- a/scala3doc/resources/dotty_res/styles/scalastyle.css +++ b/scaladoc/resources/dotty_res/styles/scalastyle.css @@ -149,7 +149,7 @@ th { font-size: 12px; } -.scala3doc_logo { +.scaladoc_logo { width: 116px; } diff --git a/scala3doc/resources/dotty_res/styles/search-bar.css b/scaladoc/resources/dotty_res/styles/search-bar.css similarity index 100% rename from scala3doc/resources/dotty_res/styles/search-bar.css rename to scaladoc/resources/dotty_res/styles/search-bar.css diff --git a/scala3doc/scala3-docs/_layouts/base.html b/scaladoc/scala3-docs/_layouts/base.html similarity index 100% rename from scala3doc/scala3-docs/_layouts/base.html rename to scaladoc/scala3-docs/_layouts/base.html diff --git a/scala3doc/scala3-docs/_layouts/blog-page.html b/scaladoc/scala3-docs/_layouts/blog-page.html similarity index 100% rename from scala3doc/scala3-docs/_layouts/blog-page.html rename to scaladoc/scala3-docs/_layouts/blog-page.html diff --git a/scala3doc/scala3-docs/_layouts/doc-page.html b/scaladoc/scala3-docs/_layouts/doc-page.html similarity index 100% rename from scala3doc/scala3-docs/_layouts/doc-page.html rename to scaladoc/scala3-docs/_layouts/doc-page.html diff --git a/scala3doc/scala3-docs/_layouts/index.html b/scaladoc/scala3-docs/_layouts/index.html similarity index 100% rename from scala3doc/scala3-docs/_layouts/index.html rename to scaladoc/scala3-docs/_layouts/index.html diff --git a/scala3doc/scala3-docs/_layouts/main.html b/scaladoc/scala3-docs/_layouts/main.html similarity index 100% rename from scala3doc/scala3-docs/_layouts/main.html rename to scaladoc/scala3-docs/_layouts/main.html diff --git a/scala3doc/scala3-docs/_layouts/search.html b/scaladoc/scala3-docs/_layouts/search.html similarity index 100% rename from scala3doc/scala3-docs/_layouts/search.html rename to scaladoc/scala3-docs/_layouts/search.html diff --git a/scala3doc/scala3-docs/blog b/scaladoc/scala3-docs/blog similarity index 100% rename from scala3doc/scala3-docs/blog rename to scaladoc/scala3-docs/blog diff --git a/scala3doc/scala3-docs/css/bootstrap.min.css b/scaladoc/scala3-docs/css/bootstrap.min.css similarity index 100% rename from scala3doc/scala3-docs/css/bootstrap.min.css rename to scaladoc/scala3-docs/css/bootstrap.min.css diff --git a/scala3doc/scala3-docs/css/color-brewer.css b/scaladoc/scala3-docs/css/color-brewer.css similarity index 100% rename from scala3doc/scala3-docs/css/color-brewer.css rename to scaladoc/scala3-docs/css/color-brewer.css diff --git a/scala3doc/scala3-docs/css/dottydoc.css b/scaladoc/scala3-docs/css/dottydoc.css similarity index 100% rename from scala3doc/scala3-docs/css/dottydoc.css rename to scaladoc/scala3-docs/css/dottydoc.css diff --git a/scala3doc/scala3-docs/css/frontpage.css b/scaladoc/scala3-docs/css/frontpage.css similarity index 100% rename from scala3doc/scala3-docs/css/frontpage.css rename to scaladoc/scala3-docs/css/frontpage.css diff --git a/scala3doc/scala3-docs/css/search.css b/scaladoc/scala3-docs/css/search.css similarity index 100% rename from scala3doc/scala3-docs/css/search.css rename to scaladoc/scala3-docs/css/search.css diff --git a/scala3doc/scala3-docs/css/sidebar.css b/scaladoc/scala3-docs/css/sidebar.css similarity index 100% rename from scala3doc/scala3-docs/css/sidebar.css rename to scaladoc/scala3-docs/css/sidebar.css diff --git a/scala3doc/scala3-docs/css/toolbar.css b/scaladoc/scala3-docs/css/toolbar.css similarity index 100% rename from scala3doc/scala3-docs/css/toolbar.css rename to scaladoc/scala3-docs/css/toolbar.css diff --git a/scala3doc/scala3-docs/docs b/scaladoc/scala3-docs/docs similarity index 100% rename from scala3doc/scala3-docs/docs rename to scaladoc/scala3-docs/docs diff --git a/scala3doc/scala3-docs/images b/scaladoc/scala3-docs/images similarity index 100% rename from scala3doc/scala3-docs/images rename to scaladoc/scala3-docs/images diff --git a/scala3doc/scala3-docs/index.html b/scaladoc/scala3-docs/index.html similarity index 100% rename from scala3doc/scala3-docs/index.html rename to scaladoc/scala3-docs/index.html diff --git a/scala3doc/scala3-docs/js/api-search.js b/scaladoc/scala3-docs/js/api-search.js similarity index 100% rename from scala3doc/scala3-docs/js/api-search.js rename to scaladoc/scala3-docs/js/api-search.js diff --git a/scala3doc/scala3-docs/js/bootstrap.min.js b/scaladoc/scala3-docs/js/bootstrap.min.js similarity index 100% rename from scala3doc/scala3-docs/js/bootstrap.min.js rename to scaladoc/scala3-docs/js/bootstrap.min.js diff --git a/scala3doc/scala3-docs/js/highlight.pack.js b/scaladoc/scala3-docs/js/highlight.pack.js similarity index 100% rename from scala3doc/scala3-docs/js/highlight.pack.js rename to scaladoc/scala3-docs/js/highlight.pack.js diff --git a/scala3doc/scala3-docs/js/jquery.min.js b/scaladoc/scala3-docs/js/jquery.min.js similarity index 100% rename from scala3doc/scala3-docs/js/jquery.min.js rename to scaladoc/scala3-docs/js/jquery.min.js diff --git a/scala3doc/scala3-docs/js/sidebar.js b/scaladoc/scala3-docs/js/sidebar.js similarity index 100% rename from scala3doc/scala3-docs/js/sidebar.js rename to scaladoc/scala3-docs/js/sidebar.js diff --git a/scala3doc/scala3-docs/js/toolbar.js b/scaladoc/scala3-docs/js/toolbar.js similarity index 100% rename from scala3doc/scala3-docs/js/toolbar.js rename to scaladoc/scala3-docs/js/toolbar.js diff --git a/scala3doc/scala3-docs/logo.svg b/scaladoc/scala3-docs/logo.svg similarity index 100% rename from scala3doc/scala3-docs/logo.svg rename to scaladoc/scala3-docs/logo.svg diff --git a/scala3doc/scala3-docs/sidebar.yml b/scaladoc/scala3-docs/sidebar.yml similarity index 100% rename from scala3doc/scala3-docs/sidebar.yml rename to scaladoc/scala3-docs/sidebar.yml diff --git a/scala3doc/scripts/linkstovisit.txt b/scaladoc/scripts/linkstovisit.txt similarity index 100% rename from scala3doc/scripts/linkstovisit.txt rename to scaladoc/scripts/linkstovisit.txt diff --git a/scala3doc/scripts/mk-index.sh b/scaladoc/scripts/mk-index.sh similarity index 100% rename from scala3doc/scripts/mk-index.sh rename to scaladoc/scripts/mk-index.sh diff --git a/scala3doc/scripts/tocheck.txt b/scaladoc/scripts/tocheck.txt similarity index 100% rename from scala3doc/scripts/tocheck.txt rename to scaladoc/scripts/tocheck.txt diff --git a/scala3doc/src/dotty/dokka/DRI.scala b/scaladoc/src/dotty/dokka/DRI.scala similarity index 100% rename from scala3doc/src/dotty/dokka/DRI.scala rename to scaladoc/src/dotty/dokka/DRI.scala diff --git a/scala3doc/src/dotty/dokka/DocContext.scala b/scaladoc/src/dotty/dokka/DocContext.scala similarity index 94% rename from scala3doc/src/dotty/dokka/DocContext.scala rename to scaladoc/src/dotty/dokka/DocContext.scala index 9306a827190c..5cb908a6b7da 100644 --- a/scala3doc/src/dotty/dokka/DocContext.scala +++ b/scaladoc/src/dotty/dokka/DocContext.scala @@ -44,7 +44,7 @@ private def sourcePostionFor(f: File)(using CompilerContext) = val sourceFile = new SourceFile(virtualFile, Codec.UTF8) SourcePosition(sourceFile, Spans.NoSpan) -// TODO (https://github.com/lampepfl/scala3doc/issues/238): provide proper error handling +// TODO (https://github.com/lampepfl/scaladoc/issues/238): provide proper error handling private def createMessage( msg: String, file: File, e: Throwable | Null)(using CompilerContext): String = val localizedMessage = s"$file: $msg" @@ -68,7 +68,7 @@ extension (r: report.type) case class NavigationNode(name: String, dri: DRI, nested: Seq[NavigationNode]) -case class DocContext(args: Scala3doc.Args, compilerContext: CompilerContext): +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 diff --git a/scala3doc/src/dotty/dokka/ExternalDocLink.scala b/scaladoc/src/dotty/dokka/ExternalDocLink.scala similarity index 89% rename from scala3doc/src/dotty/dokka/ExternalDocLink.scala rename to scaladoc/src/dotty/dokka/ExternalDocLink.scala index 05f34a9e1cc5..4f04d7322955 100644 --- a/scala3doc/src/dotty/dokka/ExternalDocLink.scala +++ b/scaladoc/src/dotty/dokka/ExternalDocLink.scala @@ -14,8 +14,8 @@ case class ExternalDocLink( enum DocumentationKind: case Javadoc extends DocumentationKind - case Scaladoc extends DocumentationKind - case Scala3doc extends DocumentationKind + case Scaladoc2 extends DocumentationKind + case Scaladoc3 extends DocumentationKind object ExternalDocLink: def parse(mapping: String): Either[String, ExternalDocLink] = @@ -33,8 +33,8 @@ object ExternalDocLink: def doctoolByName(name: String) = name match case "javadoc" => Right(DocumentationKind.Javadoc) - case "scaladoc" => Right(DocumentationKind.Scaladoc) - case "scala3doc" => Right(DocumentationKind.Scala3doc) + case "scaladoc2" => Right(DocumentationKind.Scaladoc2) + case "scaladoc3" => Right(DocumentationKind.Scaladoc3) case other => fail(s"Unknown doctool: $other") diff --git a/scala3doc/src/dotty/dokka/Main.scala b/scaladoc/src/dotty/dokka/Main.scala similarity index 91% rename from scala3doc/src/dotty/dokka/Main.scala rename to scaladoc/src/dotty/dokka/Main.scala index 007238188a63..bd90da797eda 100644 --- a/scala3doc/src/dotty/dokka/Main.scala +++ b/scaladoc/src/dotty/dokka/Main.scala @@ -17,7 +17,7 @@ object Main: def main(args: Array[String]): Unit = try // We should create our own context here... - val reporter = Scala3doc.run(args, (new ContextBase).initialCtx) + val reporter = Scaladoc.run(args, (new ContextBase).initialCtx) // Sometimes jvm is hanging, so we want to be sure that we force shout down the jvm sys.exit(if reporter.hasErrors then 1 else 0) catch diff --git a/scala3doc/src/dotty/dokka/ScalaModuleCreator.scala b/scaladoc/src/dotty/dokka/ScalaModuleCreator.scala similarity index 100% rename from scala3doc/src/dotty/dokka/ScalaModuleCreator.scala rename to scaladoc/src/dotty/dokka/ScalaModuleCreator.scala diff --git a/scala3doc/src/dotty/dokka/Scala3doc.scala b/scaladoc/src/dotty/dokka/Scaladoc.scala similarity index 96% rename from scala3doc/src/dotty/dokka/Scala3doc.scala rename to scaladoc/src/dotty/dokka/Scaladoc.scala index b88c2042b512..5298ec4289bd 100644 --- a/scala3doc/src/dotty/dokka/Scala3doc.scala +++ b/scaladoc/src/dotty/dokka/Scaladoc.scala @@ -12,7 +12,7 @@ import dotty.tools.dotc.config.Settings._ import dotty.tools.dotc.config.CommonScalaSettings import dotty.tools.dotc.reporting.Reporter -object Scala3doc: +object Scaladoc: enum CommentSyntax: case Wiki case Markdown @@ -44,7 +44,7 @@ object Scala3doc: ) def run(args: Array[String], rootContext: CompilerContext): Reporter = - val (parsedArgs, ctx) = Scala3docArgs.extract(args.toList, rootContext) + val (parsedArgs, ctx) = ScaladocArgs.extract(args.toList, rootContext) given CompilerContext = ctx def listTastyFiles(f: File): Seq[File] = diff --git a/scala3doc/src/dotty/dokka/Scala3docArgs.scala b/scaladoc/src/dotty/dokka/ScaladocArgs.scala similarity index 89% rename from scala3doc/src/dotty/dokka/Scala3docArgs.scala rename to scaladoc/src/dotty/dokka/ScaladocArgs.scala index e0c820a9f580..17a065ceb9f7 100644 --- a/scala3doc/src/dotty/dokka/Scala3docArgs.scala +++ b/scaladoc/src/dotty/dokka/ScaladocArgs.scala @@ -10,9 +10,9 @@ import java.nio.file.Files import dotty.tools.dotc.config.Settings._ import dotty.tools.dotc.config.CommonScalaSettings -import dotty.dokka.Scala3doc._ +import dotty.dokka.Scaladoc._ -class Scala3docArgs extends SettingGroup with CommonScalaSettings: +class ScaladocArgs extends SettingGroup with CommonScalaSettings: val unsupportedSettings = Seq( // Options that we like to support bootclasspath, extdirs, javabootclasspath, encoding, usejavacp, @@ -34,7 +34,7 @@ class Scala3docArgs extends SettingGroup with CommonScalaSettings: val externalDocumentationMappings: Setting[List[String]] = MultiStringSetting("-external-mappings", "external-mappings", "Mapping between regexes matching classpath entries and external documentation. " + - "'regex::[scaladoc|scala3doc|javadoc]::path' syntax is used") + "'regex::[scaladoc|scaladoc|javadoc]::path' syntax is used") val deprecatedSkipPackages: Setting[List[String]] = MultiStringSetting("-skip-packages", "packages", "Deprecated, please use `-skip-by-id` or `-skip-by-regex`") @@ -48,12 +48,12 @@ class Scala3docArgs extends SettingGroup with CommonScalaSettings: val docRootContent: Setting[String] = StringSetting("-doc-root-content", "path", "The file from which the root package documentation should be imported.", "") - def scala3docSpecificSettings: Set[Setting[_]] = + def scaladocSpecificSettings: Set[Setting[_]] = Set(sourceLinks, syntax, revision, externalDocumentationMappings, skipById, skipByRegex, deprecatedSkipPackages, docRootContent) -object Scala3docArgs: - def extract(args: List[String], rootCtx: CompilerContext):(Scala3doc.Args, CompilerContext) = - val inst = new Scala3docArgs +object ScaladocArgs: + def extract(args: List[String], rootCtx: CompilerContext):(Scaladoc.Args, CompilerContext) = + val inst = new ScaladocArgs import inst._ val initialSummary = ArgsSummary(defaultState, args, errors = Nil, warnings = Nil) @@ -75,7 +75,7 @@ object Scala3docArgs: )(s => newContext.setSetting(s.asInstanceOf[Setting[T]], newValue)) } - allSettings.filterNot(scala3docSpecificSettings.contains).foreach(setInGlobal) + allSettings.filterNot(scaladocSpecificSettings.contains).foreach(setInGlobal) given CompilerContext = newContext summary.warnings.foreach(report.warning(_)) @@ -88,7 +88,7 @@ object Scala3docArgs: val (existing, nonExisting) = inFiles.partition(_.exists) if nonExisting.nonEmpty then report.warning( - s"Scala3doc will ignore following non-existent paths: ${nonExisting.mkString(", ")}" + s"scaladoc will ignore following non-existent paths: ${nonExisting.mkString(", ")}" ) val (dirs, files) = existing.partition(_.isDirectory) @@ -97,7 +97,7 @@ object Scala3docArgs: ) if other.nonEmpty then report.warning( - s"Scala3doc suports only .tasty and .jar files, following files will be ignored: ${other.mkString(", ")}" + s"scaladoc suports only .tasty and .jar files, following files will be ignored: ${other.mkString(", ")}" ) def defaultDest(): File = diff --git a/scala3doc/src/dotty/dokka/SourceLinks.scala b/scaladoc/src/dotty/dokka/SourceLinks.scala similarity index 97% rename from scala3doc/src/dotty/dokka/SourceLinks.scala rename to scaladoc/src/dotty/dokka/SourceLinks.scala index ff6e59a4ecc3..b34119ea9f7f 100644 --- a/scala3doc/src/dotty/dokka/SourceLinks.scala +++ b/scaladoc/src/dotty/dokka/SourceLinks.scala @@ -136,10 +136,10 @@ object SourceLinks: |where is one of following: | - `github:///[/revision][#subpath]` | will match https://github.com/$organization/$repository/[blob|edit]/$revision[/$subpath]/$filePath[$lineNumber] - | when revision is not provided then requires revision to be specified as argument for scala3doc + | when revision is not provided then requires revision to be specified as argument for scaladoc | - `gitlab:///` | will match https://gitlab.com/$organization/$repository/-/[blob|edit]/$revision[/$subpath]/$filePath[$lineNumber] - | when revision is not provided then requires revision to be specified as argument for scala3doc + | when revision is not provided then requires revision to be specified as argument for scaladoc | - | | is a format for `doc-source-url` parameter scaladoc. @@ -176,6 +176,6 @@ object SourceLinks: load( ctx.args.sourceLinks, ctx.args.revision, - // TODO (https://github.com/lampepfl/scala3doc/issues/240): configure source root + // TODO (https://github.com/lampepfl/scaladoc/issues/240): configure source root Paths.get("").toAbsolutePath ) diff --git a/scala3doc/src/dotty/dokka/api.scala b/scaladoc/src/dotty/dokka/api.scala similarity index 100% rename from scala3doc/src/dotty/dokka/api.scala rename to scaladoc/src/dotty/dokka/api.scala diff --git a/scala3doc/src/dotty/dokka/compat.scala b/scaladoc/src/dotty/dokka/compat.scala similarity index 100% rename from scala3doc/src/dotty/dokka/compat.scala rename to scaladoc/src/dotty/dokka/compat.scala diff --git a/scala3doc/src/dotty/dokka/renderers/DotDiagramBuilder.scala b/scaladoc/src/dotty/dokka/renderers/DotDiagramBuilder.scala similarity index 100% rename from scala3doc/src/dotty/dokka/renderers/DotDiagramBuilder.scala rename to scaladoc/src/dotty/dokka/renderers/DotDiagramBuilder.scala diff --git a/scala3doc/src/dotty/dokka/renderers/HtmlRenderer.scala b/scaladoc/src/dotty/dokka/renderers/HtmlRenderer.scala similarity index 97% rename from scala3doc/src/dotty/dokka/renderers/HtmlRenderer.scala rename to scaladoc/src/dotty/dokka/renderers/HtmlRenderer.scala index f9a05d3e2992..d74a5be52096 100644 --- a/scala3doc/src/dotty/dokka/renderers/HtmlRenderer.scala +++ b/scaladoc/src/dotty/dokka/renderers/HtmlRenderer.scala @@ -197,7 +197,7 @@ class HtmlRenderer(rootPackage: Member, val members: Map[DRI, Member])(using ctx div (id := "leftToggler")( span(cls := "icon-toggler") ), - div(id := "scala3doc-searchBar"), + div(id := "scaladoc-searchBar"), main( div(id := "content")( parentsHtml, @@ -212,11 +212,11 @@ class HtmlRenderer(rootPackage: Member, val members: Map[DRI, Member])(using ctx ) ), raw("Generated by "), - a(href := "https://github.com/lampepfl/dotty/tree/master/scala3doc")( + a(href := "https://github.com/lampepfl/dotty/tree/master/scaladoc")( img( - src := resolveRoot(link.dri, "images/scala3doc_logo.svg"), - alt := "Scala3doc", - cls := "scala3doc_logo" + src := resolveRoot(link.dri, "images/scaladoc_logo.svg"), + alt := "scaladoc", + cls := "scaladoc_logo" ) ) ) diff --git a/scala3doc/src/dotty/dokka/renderers/Locations.scala b/scaladoc/src/dotty/dokka/renderers/Locations.scala similarity index 93% rename from scala3doc/src/dotty/dokka/renderers/Locations.scala rename to scaladoc/src/dotty/dokka/renderers/Locations.scala index f4ce9866cd6e..e1b83ad79e5f 100644 --- a/scala3doc/src/dotty/dokka/renderers/Locations.scala +++ b/scaladoc/src/dotty/dokka/renderers/Locations.scala @@ -99,16 +99,16 @@ trait Locations(using ctx: DocContext): } //TODO #263: Add anchor support - def constructPathForScaladoc(dri: DRI): String = + def constructPathForScaladoc2(dri: DRI): String = docURL + dri.asFileLocation + extension // TODO Add tests for it! - def constructPathForScala3doc(dri: DRI): String = + def constructPathForScaladoc3(dri: DRI): String = val base = docURL + dri.asFileLocation + extension if dri.anchor.isEmpty then base else base + "#" + dri.anchor link.kind match { case DocumentationKind.Javadoc => constructPathForJavadoc(dri) - case DocumentationKind.Scaladoc => constructPathForScaladoc(dri) - case DocumentationKind.Scala3doc => constructPathForScala3doc(dri) + case DocumentationKind.Scaladoc2 => constructPathForScaladoc2(dri) + case DocumentationKind.Scaladoc3 => constructPathForScaladoc3(dri) } diff --git a/scala3doc/src/dotty/dokka/renderers/MemberRenderer.scala b/scaladoc/src/dotty/dokka/renderers/MemberRenderer.scala similarity index 100% rename from scala3doc/src/dotty/dokka/renderers/MemberRenderer.scala rename to scaladoc/src/dotty/dokka/renderers/MemberRenderer.scala diff --git a/scala3doc/src/dotty/dokka/renderers/Resources.scala b/scaladoc/src/dotty/dokka/renderers/Resources.scala similarity index 94% rename from scala3doc/src/dotty/dokka/renderers/Resources.scala rename to scaladoc/src/dotty/dokka/renderers/Resources.scala index 96ed9688d0fc..6fd671b82e52 100644 --- a/scala3doc/src/dotty/dokka/renderers/Resources.scala +++ b/scaladoc/src/dotty/dokka/renderers/Resources.scala @@ -27,9 +27,9 @@ trait Resources(using ctx: DocContext) extends Locations, Writer: val str = jsonObject("filterDefaults" -> jsonObject( FilterAttributes.defaultValues.toSeq.map { case (n, v) => n -> jsonString(v) }:_* )) - Resource.Text("scripts/data.js", s"var scala3DocData = $str") + Resource.Text("scripts/data.js", s"var scaladocData = $str") - private def scala3docVersionFile = Resource.Text("scala3doc.version", BuildInfo.version) + private def scaladocVersionFile = Resource.Text("scaladoc.version", BuildInfo.version) private def projectLogo = ctx.args.projectLogo.toSeq.map { p => val path = Paths.get(p) @@ -59,7 +59,7 @@ trait Resources(using ctx: DocContext) extends Locations, Writer: "styles/diagram.css", "styles/filter-bar.css", "styles/search-bar.css", - "styles/scala3doc-searchbar.css", + "styles/scaladoc-searchbar.css", "hljs/highlight.pack.js", "hljs/LICENSE", "scripts/hljs-scala3.js", @@ -81,7 +81,7 @@ trait Resources(using ctx: DocContext) extends Locations, Writer: "https://cdnjs.cloudflare.com/ajax/libs/dagre-d3/0.6.1/dagre-d3.min.js", ).map(Resource.URL.apply) - fromResources ++ urls ++ projectLogo ++ Seq(scala3docVersionFile, dynamicJsData) + fromResources ++ urls ++ projectLogo ++ Seq(scaladocVersionFile, dynamicJsData) val searchDataPath = "scripts/searchData.js" val memberResourcesPaths = Seq(searchDataPath) ++ memberResources.map(_.path) @@ -128,7 +128,7 @@ trait Resources(using ctx: DocContext) extends Locations, Writer: dottyRes("favicon.ico"), dottyRes("fonts/dotty-icons.woff"), dottyRes("fonts/dotty-icons.ttf"), - dottyRes("images/scala3doc_logo.svg"), + dottyRes("images/scaladoc_logo.svg"), searchData(pages) ) diff --git a/scala3doc/src/dotty/dokka/renderers/SignatureRenderer.scala b/scaladoc/src/dotty/dokka/renderers/SignatureRenderer.scala similarity index 100% rename from scala3doc/src/dotty/dokka/renderers/SignatureRenderer.scala rename to scaladoc/src/dotty/dokka/renderers/SignatureRenderer.scala diff --git a/scala3doc/src/dotty/dokka/renderers/SiteRenderer.scala b/scaladoc/src/dotty/dokka/renderers/SiteRenderer.scala similarity index 100% rename from scala3doc/src/dotty/dokka/renderers/SiteRenderer.scala rename to scaladoc/src/dotty/dokka/renderers/SiteRenderer.scala diff --git a/scala3doc/src/dotty/dokka/renderers/WikiDocRenderer.scala b/scaladoc/src/dotty/dokka/renderers/WikiDocRenderer.scala similarity index 100% rename from scala3doc/src/dotty/dokka/renderers/WikiDocRenderer.scala rename to scaladoc/src/dotty/dokka/renderers/WikiDocRenderer.scala diff --git a/scala3doc/src/dotty/dokka/renderers/Writer.scala b/scaladoc/src/dotty/dokka/renderers/Writer.scala similarity index 100% rename from scala3doc/src/dotty/dokka/renderers/Writer.scala rename to scaladoc/src/dotty/dokka/renderers/Writer.scala diff --git a/scala3doc/src/dotty/dokka/site/LoadedTemplate.scala b/scaladoc/src/dotty/dokka/site/LoadedTemplate.scala similarity index 100% rename from scala3doc/src/dotty/dokka/site/LoadedTemplate.scala rename to scaladoc/src/dotty/dokka/site/LoadedTemplate.scala diff --git a/scala3doc/src/dotty/dokka/site/SidebarParser.scala b/scaladoc/src/dotty/dokka/site/SidebarParser.scala similarity index 100% rename from scala3doc/src/dotty/dokka/site/SidebarParser.scala rename to scaladoc/src/dotty/dokka/site/SidebarParser.scala diff --git a/scala3doc/src/dotty/dokka/site/StaticSiteContext.scala b/scaladoc/src/dotty/dokka/site/StaticSiteContext.scala similarity index 96% rename from scala3doc/src/dotty/dokka/site/StaticSiteContext.scala rename to scaladoc/src/dotty/dokka/site/StaticSiteContext.scala index 5f6132e0bf9c..63bc34c7df26 100644 --- a/scala3doc/src/dotty/dokka/site/StaticSiteContext.scala +++ b/scaladoc/src/dotty/dokka/site/StaticSiteContext.scala @@ -12,7 +12,7 @@ import collection.JavaConverters._ class StaticSiteContext( val root: File, - val args: Scala3doc.Args, + val args: Scaladoc.Args, val sourceLinks: SourceLinks)(using val outerCtx: CompilerContext): var memberLinkResolver: String => Option[DRI] = _ => None @@ -81,7 +81,7 @@ class StaticSiteContext( case Nil => emptyTemplate(from, from.getName) case Seq(loadedTemplate) => loadedTemplate.templateFile.copy(file = from) case _ => - // TODO (https://github.com/lampepfl/scala3doc/issues/238): provide proper error handling + // TODO (https://github.com/lampepfl/scaladoc/issues/238): provide proper error handling val msg = s"ERROR: Multiple index pages for $from found in ${indexes.map(_.file)}" throw new java.lang.RuntimeException(msg) @@ -104,7 +104,7 @@ class StaticSiteContext( Some(LoadedTemplate(processedTemplate, processedChildren.toList, from)) catch case e: RuntimeException => - // TODO (https://github.com/lampepfl/scala3doc/issues/238): provide proper error handling + // TODO (https://github.com/lampepfl/scaladoc/issues/238): provide proper error handling e.printStackTrace() None diff --git a/scala3doc/src/dotty/dokka/site/common.scala b/scaladoc/src/dotty/dokka/site/common.scala similarity index 100% rename from scala3doc/src/dotty/dokka/site/common.scala rename to scaladoc/src/dotty/dokka/site/common.scala diff --git a/scala3doc/src/dotty/dokka/site/templates.scala b/scaladoc/src/dotty/dokka/site/templates.scala similarity index 100% rename from scala3doc/src/dotty/dokka/site/templates.scala rename to scaladoc/src/dotty/dokka/site/templates.scala diff --git a/scala3doc/src/dotty/dokka/tasty/BasicSupport.scala b/scaladoc/src/dotty/dokka/tasty/BasicSupport.scala similarity index 100% rename from scala3doc/src/dotty/dokka/tasty/BasicSupport.scala rename to scaladoc/src/dotty/dokka/tasty/BasicSupport.scala diff --git a/scala3doc/src/dotty/dokka/tasty/ClassLikeSupport.scala b/scaladoc/src/dotty/dokka/tasty/ClassLikeSupport.scala similarity index 100% rename from scala3doc/src/dotty/dokka/tasty/ClassLikeSupport.scala rename to scaladoc/src/dotty/dokka/tasty/ClassLikeSupport.scala diff --git a/scala3doc/src/dotty/dokka/tasty/NameNormalizer.scala b/scaladoc/src/dotty/dokka/tasty/NameNormalizer.scala similarity index 100% rename from scala3doc/src/dotty/dokka/tasty/NameNormalizer.scala rename to scaladoc/src/dotty/dokka/tasty/NameNormalizer.scala diff --git a/scala3doc/src/dotty/dokka/tasty/PackageSupport.scala b/scaladoc/src/dotty/dokka/tasty/PackageSupport.scala similarity index 100% rename from scala3doc/src/dotty/dokka/tasty/PackageSupport.scala rename to scaladoc/src/dotty/dokka/tasty/PackageSupport.scala diff --git a/scala3doc/src/dotty/dokka/tasty/ScalaDocSupport.scala b/scaladoc/src/dotty/dokka/tasty/ScalaDocSupport.scala similarity index 97% rename from scala3doc/src/dotty/dokka/tasty/ScalaDocSupport.scala rename to scaladoc/src/dotty/dokka/tasty/ScalaDocSupport.scala index 360e7d43f42e..261a7ced9e38 100644 --- a/scala3doc/src/dotty/dokka/tasty/ScalaDocSupport.scala +++ b/scaladoc/src/dotty/dokka/tasty/ScalaDocSupport.scala @@ -3,7 +3,7 @@ package tasty import scala.jdk.CollectionConverters._ -import dotty.dokka.Scala3doc.CommentSyntax +import dotty.dokka.Scaladoc.CommentSyntax import dotty.dokka.tasty.comments.Comment trait ScaladocSupport { self: TastyParser => diff --git a/scala3doc/src/dotty/dokka/tasty/SymOps.scala b/scaladoc/src/dotty/dokka/tasty/SymOps.scala similarity index 100% rename from scala3doc/src/dotty/dokka/tasty/SymOps.scala rename to scaladoc/src/dotty/dokka/tasty/SymOps.scala diff --git a/scala3doc/src/dotty/dokka/tasty/SyntheticSupport.scala b/scaladoc/src/dotty/dokka/tasty/SyntheticSupport.scala similarity index 100% rename from scala3doc/src/dotty/dokka/tasty/SyntheticSupport.scala rename to scaladoc/src/dotty/dokka/tasty/SyntheticSupport.scala diff --git a/scala3doc/src/dotty/dokka/tasty/TastyParser.scala b/scaladoc/src/dotty/dokka/tasty/TastyParser.scala similarity index 100% rename from scala3doc/src/dotty/dokka/tasty/TastyParser.scala rename to scaladoc/src/dotty/dokka/tasty/TastyParser.scala diff --git a/scala3doc/src/dotty/dokka/tasty/TypesSupport.scala b/scaladoc/src/dotty/dokka/tasty/TypesSupport.scala similarity index 100% rename from scala3doc/src/dotty/dokka/tasty/TypesSupport.scala rename to scaladoc/src/dotty/dokka/tasty/TypesSupport.scala diff --git a/scala3doc/src/dotty/dokka/tasty/comments/Cleaner.scala b/scaladoc/src/dotty/dokka/tasty/comments/Cleaner.scala similarity index 100% rename from scala3doc/src/dotty/dokka/tasty/comments/Cleaner.scala rename to scaladoc/src/dotty/dokka/tasty/comments/Cleaner.scala diff --git a/scala3doc/src/dotty/dokka/tasty/comments/CommentExpander.scala b/scaladoc/src/dotty/dokka/tasty/comments/CommentExpander.scala similarity index 100% rename from scala3doc/src/dotty/dokka/tasty/comments/CommentExpander.scala rename to scaladoc/src/dotty/dokka/tasty/comments/CommentExpander.scala diff --git a/scala3doc/src/dotty/dokka/tasty/comments/CommentRegex.scala b/scaladoc/src/dotty/dokka/tasty/comments/CommentRegex.scala similarity index 100% rename from scala3doc/src/dotty/dokka/tasty/comments/CommentRegex.scala rename to scaladoc/src/dotty/dokka/tasty/comments/CommentRegex.scala diff --git a/scala3doc/src/dotty/dokka/tasty/comments/Comments.scala b/scaladoc/src/dotty/dokka/tasty/comments/Comments.scala similarity index 100% rename from scala3doc/src/dotty/dokka/tasty/comments/Comments.scala rename to scaladoc/src/dotty/dokka/tasty/comments/Comments.scala diff --git a/scala3doc/src/dotty/dokka/tasty/comments/MarkdownParser.scala b/scaladoc/src/dotty/dokka/tasty/comments/MarkdownParser.scala similarity index 100% rename from scala3doc/src/dotty/dokka/tasty/comments/MarkdownParser.scala rename to scaladoc/src/dotty/dokka/tasty/comments/MarkdownParser.scala diff --git a/scala3doc/src/dotty/dokka/tasty/comments/MemberLookup.scala b/scaladoc/src/dotty/dokka/tasty/comments/MemberLookup.scala similarity index 100% rename from scala3doc/src/dotty/dokka/tasty/comments/MemberLookup.scala rename to scaladoc/src/dotty/dokka/tasty/comments/MemberLookup.scala diff --git a/scala3doc/src/dotty/dokka/tasty/comments/Preparser.scala b/scaladoc/src/dotty/dokka/tasty/comments/Preparser.scala similarity index 100% rename from scala3doc/src/dotty/dokka/tasty/comments/Preparser.scala rename to scaladoc/src/dotty/dokka/tasty/comments/Preparser.scala diff --git a/scala3doc/src/dotty/dokka/tasty/comments/Queries.scala b/scaladoc/src/dotty/dokka/tasty/comments/Queries.scala similarity index 100% rename from scala3doc/src/dotty/dokka/tasty/comments/Queries.scala rename to scaladoc/src/dotty/dokka/tasty/comments/Queries.scala diff --git a/scala3doc/src/dotty/dokka/tasty/comments/markdown/DocFlexmarkExtension.scala b/scaladoc/src/dotty/dokka/tasty/comments/markdown/DocFlexmarkExtension.scala similarity index 100% rename from scala3doc/src/dotty/dokka/tasty/comments/markdown/DocFlexmarkExtension.scala rename to scaladoc/src/dotty/dokka/tasty/comments/markdown/DocFlexmarkExtension.scala diff --git a/scala3doc/src/dotty/dokka/tasty/comments/package.scala b/scaladoc/src/dotty/dokka/tasty/comments/package.scala similarity index 100% rename from scala3doc/src/dotty/dokka/tasty/comments/package.scala rename to scaladoc/src/dotty/dokka/tasty/comments/package.scala diff --git a/scala3doc/src/dotty/dokka/tasty/comments/wiki/Entities.scala b/scaladoc/src/dotty/dokka/tasty/comments/wiki/Entities.scala similarity index 100% rename from scala3doc/src/dotty/dokka/tasty/comments/wiki/Entities.scala rename to scaladoc/src/dotty/dokka/tasty/comments/wiki/Entities.scala diff --git a/scala3doc/src/dotty/dokka/tasty/comments/wiki/Parser.scala b/scaladoc/src/dotty/dokka/tasty/comments/wiki/Parser.scala similarity index 100% rename from scala3doc/src/dotty/dokka/tasty/comments/wiki/Parser.scala rename to scaladoc/src/dotty/dokka/tasty/comments/wiki/Parser.scala diff --git a/scala3doc/src/dotty/dokka/transformers/ImplicitMembersExtensionTransformer.scala b/scaladoc/src/dotty/dokka/transformers/ImplicitMembersExtensionTransformer.scala similarity index 100% rename from scala3doc/src/dotty/dokka/transformers/ImplicitMembersExtensionTransformer.scala rename to scaladoc/src/dotty/dokka/transformers/ImplicitMembersExtensionTransformer.scala diff --git a/scala3doc/src/dotty/dokka/transformers/InheritanceInformationTransformer.scala b/scaladoc/src/dotty/dokka/transformers/InheritanceInformationTransformer.scala similarity index 100% rename from scala3doc/src/dotty/dokka/transformers/InheritanceInformationTransformer.scala rename to scaladoc/src/dotty/dokka/transformers/InheritanceInformationTransformer.scala diff --git a/scala3doc/src/dotty/dokka/translators/FilterAttributes.scala b/scaladoc/src/dotty/dokka/translators/FilterAttributes.scala similarity index 100% rename from scala3doc/src/dotty/dokka/translators/FilterAttributes.scala rename to scaladoc/src/dotty/dokka/translators/FilterAttributes.scala diff --git a/scala3doc/src/dotty/dokka/translators/ScalaSignatureProvider.scala b/scaladoc/src/dotty/dokka/translators/ScalaSignatureProvider.scala similarity index 100% rename from scala3doc/src/dotty/dokka/translators/ScalaSignatureProvider.scala rename to scaladoc/src/dotty/dokka/translators/ScalaSignatureProvider.scala diff --git a/scala3doc/src/dotty/dokka/translators/ScalaSignatureUtils.scala b/scaladoc/src/dotty/dokka/translators/ScalaSignatureUtils.scala similarity index 100% rename from scala3doc/src/dotty/dokka/translators/ScalaSignatureUtils.scala rename to scaladoc/src/dotty/dokka/translators/ScalaSignatureUtils.scala diff --git a/scala3doc/src/dotty/dokka/util/IO.java b/scaladoc/src/dotty/dokka/util/IO.java similarity index 100% rename from scala3doc/src/dotty/dokka/util/IO.java rename to scaladoc/src/dotty/dokka/util/IO.java diff --git a/scala3doc/src/dotty/dokka/util/JSON.scala b/scaladoc/src/dotty/dokka/util/JSON.scala similarity index 100% rename from scala3doc/src/dotty/dokka/util/JSON.scala rename to scaladoc/src/dotty/dokka/util/JSON.scala diff --git a/scala3doc/src/dotty/dokka/util/html.scala b/scaladoc/src/dotty/dokka/util/html.scala similarity index 100% rename from scala3doc/src/dotty/dokka/util/html.scala rename to scaladoc/src/dotty/dokka/util/html.scala diff --git a/scala3doc/src/dotty/tools/dottydoc/Main.scala b/scaladoc/src/dotty/tools/dottydoc/Main.scala similarity index 93% rename from scala3doc/src/dotty/tools/dottydoc/Main.scala rename to scaladoc/src/dotty/tools/dottydoc/Main.scala index 3a6089f5353c..c529c32fd3df 100644 --- a/scala3doc/src/dotty/tools/dottydoc/Main.scala +++ b/scaladoc/src/dotty/tools/dottydoc/Main.scala @@ -22,4 +22,4 @@ object Main extends Driver: * how they're split). */ override def process(args: Array[String], rootCtx: Context): Reporter = - dotty.dokka.Scala3doc.run(args, rootCtx) + dotty.dokka.Scaladoc.run(args, rootCtx) diff --git a/scala3doc/src/scala/tasty/inspector/DocTastyInspector.scala b/scaladoc/src/scala/tasty/inspector/DocTastyInspector.scala similarity index 100% rename from scala3doc/src/scala/tasty/inspector/DocTastyInspector.scala rename to scaladoc/src/scala/tasty/inspector/DocTastyInspector.scala diff --git a/scala3doc/src/scala/tasty/inspector/OldTastyInspector.scala b/scaladoc/src/scala/tasty/inspector/OldTastyInspector.scala similarity index 100% rename from scala3doc/src/scala/tasty/inspector/OldTastyInspector.scala rename to scaladoc/src/scala/tasty/inspector/OldTastyInspector.scala diff --git a/scala3doc/test-documentations/basic/docs/Adoc.md b/scaladoc/test-documentations/basic/docs/Adoc.md similarity index 100% rename from scala3doc/test-documentations/basic/docs/Adoc.md rename to scaladoc/test-documentations/basic/docs/Adoc.md diff --git a/scala3doc/test-documentations/basic/docs/dir/index.md b/scaladoc/test-documentations/basic/docs/dir/index.md similarity index 100% rename from scala3doc/test-documentations/basic/docs/dir/index.md rename to scaladoc/test-documentations/basic/docs/dir/index.md diff --git a/scala3doc/test-documentations/basic/docs/dir/nested.md b/scaladoc/test-documentations/basic/docs/dir/nested.md similarity index 100% rename from scala3doc/test-documentations/basic/docs/dir/nested.md rename to scaladoc/test-documentations/basic/docs/dir/nested.md diff --git a/scala3doc/test-documentations/basic/docs/index.md b/scaladoc/test-documentations/basic/docs/index.md similarity index 100% rename from scala3doc/test-documentations/basic/docs/index.md rename to scaladoc/test-documentations/basic/docs/index.md diff --git a/scala3doc/test-documentations/basic/images/basic.svg b/scaladoc/test-documentations/basic/images/basic.svg similarity index 100% rename from scala3doc/test-documentations/basic/images/basic.svg rename to scaladoc/test-documentations/basic/images/basic.svg diff --git a/scala3doc/test-documentations/basic/index.md b/scaladoc/test-documentations/basic/index.md similarity index 100% rename from scala3doc/test-documentations/basic/index.md rename to scaladoc/test-documentations/basic/index.md diff --git a/scala3doc/test-documentations/noDocsIndex/docs/Adoc.md b/scaladoc/test-documentations/noDocsIndex/docs/Adoc.md similarity index 100% rename from scala3doc/test-documentations/noDocsIndex/docs/Adoc.md rename to scaladoc/test-documentations/noDocsIndex/docs/Adoc.md diff --git a/scala3doc/test-documentations/noDocsIndex/docs/dir/index.md b/scaladoc/test-documentations/noDocsIndex/docs/dir/index.md similarity index 100% rename from scala3doc/test-documentations/noDocsIndex/docs/dir/index.md rename to scaladoc/test-documentations/noDocsIndex/docs/dir/index.md diff --git a/scala3doc/test-documentations/noDocsIndex/docs/dir/nested.md b/scaladoc/test-documentations/noDocsIndex/docs/dir/nested.md similarity index 100% rename from scala3doc/test-documentations/noDocsIndex/docs/dir/nested.md rename to scaladoc/test-documentations/noDocsIndex/docs/dir/nested.md diff --git a/scala3doc/test-documentations/noDocsIndex/docs/index.md b/scaladoc/test-documentations/noDocsIndex/docs/index.md similarity index 100% rename from scala3doc/test-documentations/noDocsIndex/docs/index.md rename to scaladoc/test-documentations/noDocsIndex/docs/index.md diff --git a/scala3doc/test-documentations/noDocsIndex/images/basic.svg b/scaladoc/test-documentations/noDocsIndex/images/basic.svg similarity index 100% rename from scala3doc/test-documentations/noDocsIndex/images/basic.svg rename to scaladoc/test-documentations/noDocsIndex/images/basic.svg diff --git a/scala3doc/test-documentations/noDocsIndex/index.md b/scaladoc/test-documentations/noDocsIndex/index.md similarity index 100% rename from scala3doc/test-documentations/noDocsIndex/index.md rename to scaladoc/test-documentations/noDocsIndex/index.md diff --git a/scala3doc/test-documentations/noGlobalIndex/docs/Adoc.md b/scaladoc/test-documentations/noGlobalIndex/docs/Adoc.md similarity index 100% rename from scala3doc/test-documentations/noGlobalIndex/docs/Adoc.md rename to scaladoc/test-documentations/noGlobalIndex/docs/Adoc.md diff --git a/scala3doc/test-documentations/noGlobalIndex/docs/dir/index.md b/scaladoc/test-documentations/noGlobalIndex/docs/dir/index.md similarity index 100% rename from scala3doc/test-documentations/noGlobalIndex/docs/dir/index.md rename to scaladoc/test-documentations/noGlobalIndex/docs/dir/index.md diff --git a/scala3doc/test-documentations/noGlobalIndex/docs/dir/nested.md b/scaladoc/test-documentations/noGlobalIndex/docs/dir/nested.md similarity index 100% rename from scala3doc/test-documentations/noGlobalIndex/docs/dir/nested.md rename to scaladoc/test-documentations/noGlobalIndex/docs/dir/nested.md diff --git a/scala3doc/test-documentations/noGlobalIndex/docs/index.md b/scaladoc/test-documentations/noGlobalIndex/docs/index.md similarity index 100% rename from scala3doc/test-documentations/noGlobalIndex/docs/index.md rename to scaladoc/test-documentations/noGlobalIndex/docs/index.md diff --git a/scala3doc/test-documentations/noGlobalIndex/images/basic.svg b/scaladoc/test-documentations/noGlobalIndex/images/basic.svg similarity index 100% rename from scala3doc/test-documentations/noGlobalIndex/images/basic.svg rename to scaladoc/test-documentations/noGlobalIndex/images/basic.svg diff --git a/scala3doc/test-documentations/noIndexes/docs/Adoc.md b/scaladoc/test-documentations/noIndexes/docs/Adoc.md similarity index 100% rename from scala3doc/test-documentations/noIndexes/docs/Adoc.md rename to scaladoc/test-documentations/noIndexes/docs/Adoc.md diff --git a/scala3doc/test-documentations/noIndexes/docs/dir/index.md b/scaladoc/test-documentations/noIndexes/docs/dir/index.md similarity index 100% rename from scala3doc/test-documentations/noIndexes/docs/dir/index.md rename to scaladoc/test-documentations/noIndexes/docs/dir/index.md diff --git a/scala3doc/test-documentations/noIndexes/docs/dir/nested.md b/scaladoc/test-documentations/noIndexes/docs/dir/nested.md similarity index 100% rename from scala3doc/test-documentations/noIndexes/docs/dir/nested.md rename to scaladoc/test-documentations/noIndexes/docs/dir/nested.md diff --git a/scala3doc/test-documentations/noIndexes/images/basic.svg b/scaladoc/test-documentations/noIndexes/images/basic.svg similarity index 100% rename from scala3doc/test-documentations/noIndexes/images/basic.svg rename to scaladoc/test-documentations/noIndexes/images/basic.svg diff --git a/scala3doc/test/dotty/dokka/BaseHtmlTest.scala b/scaladoc/test/dotty/dokka/BaseHtmlTest.scala similarity index 96% rename from scala3doc/test/dotty/dokka/BaseHtmlTest.scala rename to scaladoc/test/dotty/dokka/BaseHtmlTest.scala index 09b6745c3ce1..36e802752854 100644 --- a/scala3doc/test/dotty/dokka/BaseHtmlTest.scala +++ b/scaladoc/test/dotty/dokka/BaseHtmlTest.scala @@ -29,14 +29,14 @@ class BaseHtmlTest: ): Unit = val dest = Files.createTempDirectory("test-doc") try - val args = Scala3doc.Args( + val args = Scaladoc.Args( name = projectName, tastyFiles = pcks.flatMap(tastyFiles), output = dest.toFile, docsRoot = docsRoot, projectVersion = Some(projectVersion), ) - Scala3doc.run(args)(using testContext) + Scaladoc.run(args)(using testContext) op(using ProjectContext(dest)) finally IO.delete(dest.toFile) diff --git a/scala3doc/test/dotty/dokka/ExternalLocationProviderIntegrationTest.scala b/scaladoc/test/dotty/dokka/ExternalLocationProviderIntegrationTest.scala similarity index 87% rename from scala3doc/test/dotty/dokka/ExternalLocationProviderIntegrationTest.scala rename to scaladoc/test/dotty/dokka/ExternalLocationProviderIntegrationTest.scala index eb7e38fbc749..82f03319c459 100644 --- a/scala3doc/test/dotty/dokka/ExternalLocationProviderIntegrationTest.scala +++ b/scaladoc/test/dotty/dokka/ExternalLocationProviderIntegrationTest.scala @@ -18,9 +18,9 @@ class JavadocExternalLocationProviderIntegrationTest extends ExternalLocationPro ) ) -class ScaladocExternalLocationProviderIntegrationTest extends ExternalLocationProviderIntegrationTest( - "externalScaladoc", - List(".*scala.*::scaladoc::https://www.scala-lang.org/api/current/"), +class Scaladoc2ExternalLocationProviderIntegrationTest extends ExternalLocationProviderIntegrationTest( + "externalScaladoc2", + List(".*scala.*::scaladoc2::https://www.scala-lang.org/api/current/"), List( "https://www.scala-lang.org/api/current/scala/util/matching/Regex$$Match.html", "https://www.scala-lang.org/api/current/scala/Predef$.html", @@ -28,9 +28,9 @@ class ScaladocExternalLocationProviderIntegrationTest extends ExternalLocationPr ) ) -class Scala3docExternalLocationProviderIntegrationTest extends ExternalLocationProviderIntegrationTest( - "externalScala3doc", - List(".*scala.*::scala3doc::https://dotty.epfl.ch/api/"), +class Scaladoc3ExternalLocationProviderIntegrationTest extends ExternalLocationProviderIntegrationTest( + "externalScaladoc3", + List(".*scala.*::scaladoc3::https://dotty.epfl.ch/api/"), List( "https://dotty.epfl.ch/api/scala/collection/immutable/Map.html", "https://dotty.epfl.ch/api/scala/Predef$.html#String", diff --git a/scala3doc/test/dotty/dokka/RaportingTest.scala b/scaladoc/test/dotty/dokka/RaportingTest.scala similarity index 93% rename from scala3doc/test/dotty/dokka/RaportingTest.scala rename to scaladoc/test/dotty/dokka/RaportingTest.scala index 13bb84b2a688..450aeb75d1f2 100644 --- a/scala3doc/test/dotty/dokka/RaportingTest.scala +++ b/scaladoc/test/dotty/dokka/RaportingTest.scala @@ -11,7 +11,7 @@ import java.nio.charset.Charset import util.IO class ReportingTest: - import Scala3doc.Args + import Scaladoc.Args private def checkReportedDiagnostics( newArgs: Args => Args = identity, @@ -21,7 +21,7 @@ class ReportingTest: val dest = Files.createTempDirectory("test-doc") try // We are using random package - Scala3doc.run(newArgs(testArgs(tastyFiles("nested"), dest.toFile)))(using ctx) + Scaladoc.run(newArgs(testArgs(tastyFiles("nested"), dest.toFile)))(using ctx) op(ctx.reportedDiagnostics) finally IO.delete(dest.toFile) diff --git a/scala3doc/test/dotty/dokka/ScaladocTest.scala b/scaladoc/test/dotty/dokka/ScaladocTest.scala similarity index 91% rename from scala3doc/test/dotty/dokka/ScaladocTest.scala rename to scaladoc/test/dotty/dokka/ScaladocTest.scala index 5b1afc1cc6dd..4ebe5931f782 100644 --- a/scala3doc/test/dotty/dokka/ScaladocTest.scala +++ b/scaladoc/test/dotty/dokka/ScaladocTest.scala @@ -8,7 +8,7 @@ import java.io.File abstract class ScaladocTest(val name: String): def afterRendering(op: DocContext ?=> Unit) = - val ctx = Scala3doc.run(args)(using testContext) + val ctx = Scaladoc.run(args)(using testContext) op(using ctx) @@ -21,7 +21,7 @@ abstract class ScaladocTest(val name: String): folder.create() folder - def args = Scala3doc.Args( + def args = Scaladoc.Args( name = "test", tastyFiles = tastyFiles(name), output = getTempDir().getRoot, diff --git a/scala3doc/test/dotty/dokka/SignatureTest.scala b/scaladoc/test/dotty/dokka/SignatureTest.scala similarity index 100% rename from scala3doc/test/dotty/dokka/SignatureTest.scala rename to scaladoc/test/dotty/dokka/SignatureTest.scala diff --git a/scala3doc/test/dotty/dokka/SignatureTestCases.scala b/scaladoc/test/dotty/dokka/SignatureTestCases.scala similarity index 100% rename from scala3doc/test/dotty/dokka/SignatureTestCases.scala rename to scaladoc/test/dotty/dokka/SignatureTestCases.scala diff --git a/scala3doc/test/dotty/dokka/SourceLinksTests.scala b/scaladoc/test/dotty/dokka/SourceLinksTests.scala similarity index 98% rename from scala3doc/test/dotty/dokka/SourceLinksTests.scala rename to scaladoc/test/dotty/dokka/SourceLinksTests.scala index 92fa9b1c7cb8..a4b9f245b54f 100644 --- a/scala3doc/test/dotty/dokka/SourceLinksTests.scala +++ b/scaladoc/test/dotty/dokka/SourceLinksTests.scala @@ -54,7 +54,7 @@ class SourceLinkTest: } class SourceLinksTest: - // TODO (https://github.com/lampepfl/scala3doc/issues/240): configure source root + // TODO (https://github.com/lampepfl/scaladoc/issues/240): configure source root val projectRoot = Paths.get("").toAbsolutePath() val edit: Operation = "edit" // union types need explicit singletons diff --git a/scala3doc/test/dotty/dokka/diagram/HierarchyTest.scala b/scaladoc/test/dotty/dokka/diagram/HierarchyTest.scala similarity index 100% rename from scala3doc/test/dotty/dokka/diagram/HierarchyTest.scala rename to scaladoc/test/dotty/dokka/diagram/HierarchyTest.scala diff --git a/scala3doc/test/dotty/dokka/linking/DriTest.scala b/scaladoc/test/dotty/dokka/linking/DriTest.scala similarity index 100% rename from scala3doc/test/dotty/dokka/linking/DriTest.scala rename to scaladoc/test/dotty/dokka/linking/DriTest.scala diff --git a/scala3doc/test/dotty/dokka/linking/DriTestCases.scala b/scaladoc/test/dotty/dokka/linking/DriTestCases.scala similarity index 100% rename from scala3doc/test/dotty/dokka/linking/DriTestCases.scala rename to scaladoc/test/dotty/dokka/linking/DriTestCases.scala diff --git a/scala3doc/test/dotty/dokka/renderers/HtmlTagsTest.scala b/scaladoc/test/dotty/dokka/renderers/HtmlTagsTest.scala similarity index 100% rename from scala3doc/test/dotty/dokka/renderers/HtmlTagsTest.scala rename to scaladoc/test/dotty/dokka/renderers/HtmlTagsTest.scala diff --git a/scala3doc/test/dotty/dokka/renderers/LocationTests.scala b/scaladoc/test/dotty/dokka/renderers/LocationTests.scala similarity index 100% rename from scala3doc/test/dotty/dokka/renderers/LocationTests.scala rename to scaladoc/test/dotty/dokka/renderers/LocationTests.scala diff --git a/scala3doc/test/dotty/dokka/site/NavigationTest.scala b/scaladoc/test/dotty/dokka/site/NavigationTest.scala similarity index 100% rename from scala3doc/test/dotty/dokka/site/NavigationTest.scala rename to scaladoc/test/dotty/dokka/site/NavigationTest.scala diff --git a/scala3doc/test/dotty/dokka/site/SiteGeneratationTest.scala b/scaladoc/test/dotty/dokka/site/SiteGeneratationTest.scala similarity index 100% rename from scala3doc/test/dotty/dokka/site/SiteGeneratationTest.scala rename to scaladoc/test/dotty/dokka/site/SiteGeneratationTest.scala diff --git a/scala3doc/test/dotty/dokka/site/StaticSiteContextTest.scala b/scaladoc/test/dotty/dokka/site/StaticSiteContextTest.scala similarity index 100% rename from scala3doc/test/dotty/dokka/site/StaticSiteContextTest.scala rename to scaladoc/test/dotty/dokka/site/StaticSiteContextTest.scala diff --git a/scala3doc/test/dotty/dokka/site/TemplateFileTests.scala b/scaladoc/test/dotty/dokka/site/TemplateFileTests.scala similarity index 100% rename from scala3doc/test/dotty/dokka/site/TemplateFileTests.scala rename to scaladoc/test/dotty/dokka/site/TemplateFileTests.scala diff --git a/scala3doc/test/dotty/dokka/tasty/comments/CommentExpanderTests.scala b/scaladoc/test/dotty/dokka/tasty/comments/CommentExpanderTests.scala similarity index 100% rename from scala3doc/test/dotty/dokka/tasty/comments/CommentExpanderTests.scala rename to scaladoc/test/dotty/dokka/tasty/comments/CommentExpanderTests.scala diff --git a/scala3doc/test/dotty/dokka/tasty/comments/DocFlexmarkParserTests.scala b/scaladoc/test/dotty/dokka/tasty/comments/DocFlexmarkParserTests.scala similarity index 100% rename from scala3doc/test/dotty/dokka/tasty/comments/DocFlexmarkParserTests.scala rename to scaladoc/test/dotty/dokka/tasty/comments/DocFlexmarkParserTests.scala diff --git a/scala3doc/test/dotty/dokka/tasty/comments/IntegrationTest.scala b/scaladoc/test/dotty/dokka/tasty/comments/IntegrationTest.scala similarity index 100% rename from scala3doc/test/dotty/dokka/tasty/comments/IntegrationTest.scala rename to scaladoc/test/dotty/dokka/tasty/comments/IntegrationTest.scala diff --git a/scala3doc/test/dotty/dokka/tasty/comments/MemberLookupTests.scala b/scaladoc/test/dotty/dokka/tasty/comments/MemberLookupTests.scala similarity index 100% rename from scala3doc/test/dotty/dokka/tasty/comments/MemberLookupTests.scala rename to scaladoc/test/dotty/dokka/tasty/comments/MemberLookupTests.scala diff --git a/scala3doc/test/dotty/dokka/tasty/comments/QueryParserTests.scala b/scaladoc/test/dotty/dokka/tasty/comments/QueryParserTests.scala similarity index 100% rename from scala3doc/test/dotty/dokka/tasty/comments/QueryParserTests.scala rename to scaladoc/test/dotty/dokka/tasty/comments/QueryParserTests.scala diff --git a/scala3doc/test/dotty/dokka/tasty/util/TestUtils.scala b/scaladoc/test/dotty/dokka/tasty/util/TestUtils.scala similarity index 100% rename from scala3doc/test/dotty/dokka/tasty/util/TestUtils.scala rename to scaladoc/test/dotty/dokka/tasty/util/TestUtils.scala diff --git a/scala3doc/test/dotty/dokka/testUtils.scala b/scaladoc/test/dotty/dokka/testUtils.scala similarity index 97% rename from scala3doc/test/dotty/dokka/testUtils.scala rename to scaladoc/test/dotty/dokka/testUtils.scala index 8d3db74371a3..fa5a04664ab7 100644 --- a/scala3doc/test/dotty/dokka/testUtils.scala +++ b/scaladoc/test/dotty/dokka/testUtils.scala @@ -50,7 +50,7 @@ class TestReporter extends ConsoleReporter: warnings += dia super.doReport(dia) -def testArgs(files: Seq[File] = Nil, dest: File = new File("notUsed")) = Scala3doc.Args( +def testArgs(files: Seq[File] = Nil, dest: File = new File("notUsed")) = Scaladoc.Args( name = "Test Project Name", output = dest, tastyFiles = files, @@ -62,7 +62,7 @@ def testDocContext = DocContext(testArgs(), testContext) def tastyFiles(name: String) = def listFilesSafe(dir: File) = Option(dir.listFiles).getOrElse { - throw AssertionError(s"$dir not found. The test name is incorrect or scala3doc-testcases were not recompiled.") + throw AssertionError(s"$dir not found. The test name is incorrect or scaladoc-testcases were not recompiled.") } def collectFiles(dir: File): List[File] = listFilesSafe(dir).toList.flatMap { case f if f.isDirectory => collectFiles(f) diff --git a/scala3doc/test/dotty/dokka/util/JSONTest.scala b/scaladoc/test/dotty/dokka/util/JSONTest.scala similarity index 100% rename from scala3doc/test/dotty/dokka/util/JSONTest.scala rename to scaladoc/test/dotty/dokka/util/JSONTest.scala