POSIX compliant utility argument

Author: BryanAbate

tastydoc/TODO.md

@@ -3,13 +3,6 @@
 * util.traversing
   * ImplicitlyAddedFrom
   * Fix linking for inherited method
-* Comment
-  * Span + error printing
-  * Figure out ShortHtml
-* CommentParser
-  * Span + error printing
-* WikiParser (just error reporting (span))
-  * Span + error printing
 
 # Other
 * Check remaining TODOs/TOASKs/TOFIX
@@ -22,24 +15,10 @@
 # Output
 * Output inner class/object if not inherited
 
-# Features for beyond the project
-* TypeLambdas
-* Inherited declaration
-* handle things such as $genericCanBuildFromInfo
-* Type like Graph.Node
-* default value in def
-* Case classes are linked
-* Error printing in parsing
-
-# Report
-* Be consistent in methods/function and parameters/arguments
-
 # To Ask
 * Error in calling owner
 * Order in type matching symbol counts...
 * Remove artifacts in packages
 * No way to get doc for packages?
 * Abstract flag not working
-* filter(!_.symbol.flags.is(Flags.StableRealizable)) good idea or not?
-
-* Not consistant reference (f.ex object in parents)
+* filter(!_.symbol.flags.is(Flags.StableRealizable)) good idea or not?

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 of packages or entities (example: `scala.collection.*`). Only the types with a path matching these regexes will produce links in the documentation files
-* **--classpath** {*URI*} Extra classpath for input files
-* **-i** {*file1 file2 ...*} TASTy files
-* **-d** {*dir1 dir2 ...*} Directories to recursively find TASTy files
+* **[--syntax SYNTAX]** Syntax for parsing user documentation (either *wiki or markdown*)
+* **[--packagestolink REGEXES...]** Regexes of packages or entities (example: `scala.collection.*`). Only the types with a path matching these regexes will produce links in the documentation files
+* **[--classpath URI]** Extra classpath for input files
+* **[-i FILES...]** TASTy files
+* **[-d DIRECTORIES...]** Directories to recursively find TASTy files

tastydoc/report/report.pdf

@@ -208,11 +208,11 @@ \subsection{Main}
 
 Command line parameters 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 of packages or entities (example: \texttt{scala.collection.*}). Only the types with a path matching these regexes will produce links in the documentation files
-    \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
+    \item \textbf{\texttt{[--syntax SYNTAX]}} Syntax to use for user documentation parsing (either \textit{wiki} or \textit{markdown})
+    \item \textbf{\texttt{[--packagestolink REGEXES...]}} Regexes of packages or entities (example: \texttt{scala.collection.*}). Only the types with a path matching these regexes will produce links in the documentation files
+    \item \textbf{\texttt{[--classpath URI]}} Extra classpath for input files
+    \item \textbf{\texttt{[-i FILES...]}} TASTy files
+    \item \textbf{\texttt{[-d DIRECTORIES...]}} Directories to recursively find TASTy files
 \end{itemize}
 
 \subsection{User documentation parsing}

tastydoc/report/report.tex

@@ -10,11 +10,11 @@ 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 of packages or entities (example: `scala.collection.*`). Only the types with a path matching these regexes will produce links in the documentation files
-   * * **--classpath** {*URI*} Extra classpath for input files
-   * * **-i** {*file1 file2 ...*} TASTy files
-   * * **-d** {*dir1 dir2 ...*} Directories to recursively find TASTy files
+   * * **[--syntax SYNTAX]** Syntax for parsing user documentation (either *wiki or markdown*)
+   * * **[--packagestolink REGEXES...]** Regexes of packages or entities (example: `scala.collection.*`). Only the types with a path matching these regexes will produce links in the documentation files
+   * * **[--classpath URI]** Extra classpath for input files
+   * * **[-i FILES...]** TASTy files
+   * * **[-d DIRECTORIES...]** Directories to recursively find TASTy files
    */
   def main(args: Array[String]): Unit = {
     val userDocSyntax = {