You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: tastydoc/readme.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ This tool produces Markdown documentation files for Scala projects using TASTy f
5
5
## How to run
6
6
Call main with the following arguments to produce Markdown documentation files: (Omitting { and })
7
7
***--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
9
9
***--classpath** {*URI*} Extra classpath for input files
10
10
***-i** {*file1 file2 ...*} TASTy files
11
11
***-d** {*dir1 dir2 ...*} Directories to recursively find TASTy files
Copy file name to clipboardExpand all lines: tastydoc/src/dotty/tastydoc/Main.scala
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ object Main {
11
11
12
12
/** Call main with the following arguments to produce Markdown documentation files: (Omitting { and })
13
13
* * **--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
15
15
* * **--classpath** {*URI*} Extra classpath for input files
0 commit comments