Readme

Author: BryanAbate

tastydoc/readme.md

@@ -1,50 +1,11 @@
-# SemanticDB
+# Tastydoc
 
-To run the tests use two terminals. In the first terminal compile the
-`semanticdb/input` project whenever sources change in
-`semanticdb/input/src/main/scala/**.scala`.
+This tool produces Markdown documentation files for Scala projects using TASTy files.
 
-```
-cd semanticdb/input
-sbt
-> compile
-```
-
-In the second terminal, run `sbt dotty-semanticdb/test` from the main dotty
-build
-
-```
-sbt
-> dotty-semanticdb/test
-```
-
-The tests assert that the TASTy to SemanticDB converter produces the same output
-as the semanticdb-scalac compiler plugin. Test failures result in diffs like
-this
-
-```diff
-Test dotty.semanticdb.Tests.testExample failed: java.lang.AssertionError:
---- tasty
-+++ scala2
--class Example {
--  val a: String = "1"
-+class Example /*example/Example#*/  {
-+  val a /*example/Example#a.*/ : String /*scala/Predef.String#*/  = "1"
-```
-
-The lines starting with `-` are the output from the TASTy converter and the
-lines starting with `+` are the output from the semanticdb-scalac compiler
-plugin.
-
-Once the TASTy converter is updated to emit correct `SymbolOccurrence`
-(https://scalameta.org/docs/semanticdb/specification.html#symboloccurrence) then
-the "tasty" output should become identical to "scala2" and include inline
-comments `class Example /* pkg/Example# */`. The inline comments are read as:
-"the symbol `pkg/Example#` was resolved next to the class name `Example`".
-
-The spec for SemanticDB symbols can be found here:
-
-- Scala symbols:
-  https://scalameta.org/docs/semanticdb/specification.html#scala-symbol
-- Java symbols:
-  https://scalameta.org/docs/semanticdb/specification.html#java-symbol
+## How to run
+Call main with the following arguments to produce Markdown documentation files: (Omitting { and })
+* **-syntax** {*wiki or markdown*} Syntax for parsing user documentation
+* **-packagestolink** {*regex1 regex2 ...*} Regexes to specify which packages should be linked when formatting Reference
+* **-classpath** {*URI*} Extra classpath for input files
+* **-i** {*file1 file2 ...*} TASTy files
+* **-d** {*dir1 dir2 ...*} Directories to recursively find TASTy files

tastydoc/src/dotty/tastydoc/Main.scala

@@ -9,7 +9,7 @@ import java.io._
 
 object Main {
 
-  /** Call main with the following arguments to produce documentaiton Markdown files: (Omitting { and })
+  /** Call main with the following arguments to produce Markdown documentation files: (Omitting { and })
    * * **-syntax** {*wiki or markdown*} Syntax for parsing user documentation
    * * **-packagestolink** {*regex1 regex2 ...*} Regexes to specify which packages should be linked when formatting Reference
    * * **-classpath** {*URI*} Extra classpath for input files