Convention for --

Author: BryanAbate

tastydoc/readme.md

@@ -4,8 +4,8 @@ This tool produces Markdown documentation files for Scala projects using TASTy f
 
 ## 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
+* **--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/report/report.pdf

@@ -183,9 +183,9 @@ \subsection{Main}
 
 Command line arguments are:
 \begin{itemize}
-    \item \textbf{-syntax} \{\textit{wiki} or \textit{markdown}\} Syntax to use for user documentation parsing
-    \item \textbf{-packagestolink} \{\textit{regex1 regex2 ...}\} Regexes to specify which packages should be linked when formatting References
-    \item \textbf{-classpath} \{\textit{URI}\} Extra classpath for input files
+    \item \textbf{--syntax} \{\textit{wiki} or \textit{markdown}\} Syntax to use for user documentation parsing
+    \item \textbf{--packagestolink} \{\textit{regex1 regex2 ...}\} Regexes to specify which packages should be linked when formatting References
+    \item \textbf{--classpath} \{\textit{URI}\} Extra classpath for input files
     \item \textbf{-i} \{\textit{file1 file2 ...}\} TASTy files
     \item \textbf{-d} \{\textit{dir1 dir2 ...}\} Directories to recursively find TASTy files
 \end{itemize}

tastydoc/report/report.tex

@@ -10,15 +10,15 @@ import java.io._
 object Main {
 
   /** 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
+   * * **--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
    */
   def main(args: Array[String]): Unit = {
     val userDocSyntax = {
-      val idx = args.indexOf("-syntax")
+      val idx = args.indexOf("--syntax")
       if(idx >= 0 && args.size > idx + 1){
         if(args(idx + 1) == "markdown"){
           "markdown"
@@ -34,7 +34,7 @@ object Main {
     }
 
     val packagesToLink = {
-      val idx = args.indexOf("-packagestolink")
+      val idx = args.indexOf("--packagestolink")
       if(idx >= 0 && args.size > idx + 1){
         args.drop(idx + 1).takeWhile(! _.startsWith("-")).toList
       }else{
@@ -44,7 +44,7 @@ object Main {
 
 
     val extraClasspath = {
-      val idx = args.indexOf("-classpath")
+      val idx = args.indexOf("--classpath")
       if(idx >= 0 && args.size > idx + 1){
         args(idx + 1)
       }else{

tastydoc/src/dotty/tastydoc/Main.scala

@@ -51,12 +51,12 @@ class Tests {
   // }
   @Test def testDocumentation(): Unit = {
     Main.main(Array(
-      "-classpath",
+      "--classpath",
       "tastydoc/out/bootstrap/dotty-tastydoc-input/scala-0.16/classes",
-      "-syntax",
+      "--syntax",
       "wiki",
       //"markdown",
-      "-packagestolink",
+      "--packagestolink",
       "example.*",
       //"scala.*",
       "-i",
@@ -73,23 +73,23 @@ class Tests {
   }
   @Test def testListFromLib(): Unit = {
     Main.main(Array(
-      "-classpath",
+      "--classpath",
       "tastydoc/out/bootstrap/dotty-tastydoc-input/scala-0.16/classes",
-      "-syntax",
+      "--syntax",
       "wiki",
-      "-packagestolink",
+      "--packagestolink",
       "scala.*",
       "-i",
       "scala.collection.immutable.List"
     ))
   }
   // @Test def testDotty(): Unit = {
   //   Main.main(Array(
-  //     "-classpath",
+  //     "--classpath",
   //     "tastydoc/dotty-0.15.0-RC1/lib",
-  //     "-syntax",
+  //     "--syntax",
   //     "wiki",
-  //     "-packagestolink",
+  //     "--packagestolink",
   //     "dotty.*",
   //     "scala.internal.*",
   //     "scala.annotation.*",