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/report/report.tex
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -117,7 +117,7 @@ \subsection{Representation}
117
117
118
118
A Representation contains all the information of a specific entity. The logic is as follows: there are different traits such as \texttt{Modifiers} or \texttt{Members} and classes which implement those traits. That logic is inspired by dotty-doc Entities\footnote{\texttt{dotty/tools/dottydoc/Entity.scala}}.
119
119
120
-
A Representation take a reflect class such as \texttt{reflect.ClassDef} and extract every information from it using mostly \texttt{TastyExtractor} functions while converting types to References using \texttt{TastyTypeConverter} functions.
120
+
A Representation take a reflect class such as \texttt{reflect.ClassDef} and extract every information from it using mostly \texttt{TastyExtractor} methods while converting types to References using \texttt{TastyTypeConverter} methods.
121
121
122
122
Representations then can be easily used for printing: their content is self-explanatory and their use requires no knowledge of TASTy as the implementation is not exposed from the outside.
123
123
@@ -165,23 +165,23 @@ \subsection{Representation}
165
165
\subsection{DocPrinter}
166
166
File: \texttt{dotty/tastydoc/DocPrinter.scala}
167
167
168
-
Object with functions that formats Representations and References to Markdown and writes them to files. Basically, it handles all the formatting and printing logic of the tool.
168
+
Object with methods that formats Representations and References to Markdown and writes them to files. Basically, it handles all the formatting and printing logic of the tool.
169
169
170
170
\subsection{mdscala}
171
171
File: \texttt{dotty/tastydoc/mdscala.scala}
172
172
173
-
Object that has helper functions for outputting markdown. Unfortunately, it does not handle escaping as it is a non-trivial task and would require a significant amount of time (see \autoref{sec:problems}).
173
+
Object that has helper methods for outputting markdown. Unfortunately, it does not handle escaping as it is a non-trivial task and would require a significant amount of time (see \autoref{sec:problems}).
Extends TastyConsumer and consumes TASTy files to produce Representations. It needs a \texttt{mutable.HashMap[String, EmulatedPackageRepresentation]} as parameters for adding every new seen package to the map. This behaviour is required for two reasons: to link inside user documentation and to have a data structure for storing converted Representations.
178
+
Extends TastyConsumer and consumes TASTy files to produce Representations. It needs a \texttt{mutable.HashMap[String, EmulatedPackageRepresentation]} as arguments for adding every new seen package to the map. This behaviour is required for two reasons: to link inside user documentation and to have a data structure for storing converted Representations.
179
179
\subsection{Main}
180
180
File: \texttt{dotty/tastydoc/Main.scala}
181
181
182
182
Manages the workflow (see \autoref{sec:workflow}).
183
183
184
-
Command line arguments are:
184
+
Command line parameters are:
185
185
\begin{itemize}
186
186
\item\textbf{--syntax} \{\textit{wiki} or \textit{markdown}\} Syntax to use for user documentation parsing
187
187
\item\textbf{--packagestolink} \{\textit{regex1 regex2 ...}\} Regexes to specify which packages should be linked when formatting References
0 commit comments