Skip to content

Commit eb47d6b

Browse files
committed
Some cleaning
1 parent 2ccb42d commit eb47d6b

File tree

7 files changed

+2
-666
lines changed

7 files changed

+2
-666
lines changed

tastydoc/TreeOpsDoc.md

Lines changed: 0 additions & 77 deletions
This file was deleted.

tastydoc/docOutputTest.md

Lines changed: 0 additions & 281 deletions
This file was deleted.

tastydoc/readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This tool produces Markdown documentation files for Scala projects using TASTy f
55
## How to run
66
Call main with the following arguments to produce Markdown documentation files: (Omitting { and })
77
* **--syntax** {*wiki or markdown*} Syntax for parsing user documentation
8-
* **--packagestolink** {*regex1 regex2 ...*} Regexes to specify which packages should be linked when formatting Reference
8+
* **--packagestolink** {*regex1 regex2 ...*} Regexes of packages or entities (example: `scala.collection.*`). Only the types with a path matching these regexes will produce links in the documentation files
99
* **--classpath** {*URI*} Extra classpath for input files
1010
* **-i** {*file1 file2 ...*} TASTy files
1111
* **-d** {*dir1 dir2 ...*} Directories to recursively find TASTy files

tastydoc/src/dotty/tastydoc/Main.scala

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ object Main {
1111

1212
/** Call main with the following arguments to produce Markdown documentation files: (Omitting { and })
1313
* * **--syntax** {*wiki or markdown*} Syntax for parsing user documentation
14-
* * **--packagestolink** {*regex1 regex2 ...*} Regexes to specify which packages should be linked when formatting Reference
14+
* * **--packagestolink** {*regex1 regex2 ...*} Regexes of packages or entities (example: `scala.collection.*`). Only the types with a path matching these regexes will produce links in the documentation files
1515
* * **--classpath** {*URI*} Extra classpath for input files
1616
* * **-i** {*file1 file2 ...*} TASTy files
1717
* * **-d** {*dir1 dir2 ...*} Directories to recursively find TASTy files

0 commit comments

Comments
 (0)