Skip to content

Commit 64bca30

Browse files
committed
Harmonization
1 parent 3026f19 commit 64bca30

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

tastydoc/report/report.pdf

3 Bytes
Binary file not shown.

tastydoc/report/report.tex

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ \subsection{Representation}
117117

118118
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}}.
119119

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.
121121

122122
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.
123123

@@ -165,23 +165,23 @@ \subsection{Representation}
165165
\subsection{DocPrinter}
166166
File: \texttt{dotty/tastydoc/DocPrinter.scala}
167167

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.
169169

170170
\subsection{mdscala}
171171
File: \texttt{dotty/tastydoc/mdscala.scala}
172172

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}).
174174

175175
\subsection{TastyDocConsumer}
176176
File: \texttt{dotty/tastydoc/TastyDocConsumer.scala}
177177

178-
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.
179179
\subsection{Main}
180180
File: \texttt{dotty/tastydoc/Main.scala}
181181

182182
Manages the workflow (see \autoref{sec:workflow}).
183183

184-
Command line arguments are:
184+
Command line parameters are:
185185
\begin{itemize}
186186
\item \textbf{--syntax} \{\textit{wiki} or \textit{markdown}\} Syntax to use for user documentation parsing
187187
\item \textbf{--packagestolink} \{\textit{regex1 regex2 ...}\} Regexes to specify which packages should be linked when formatting References

0 commit comments

Comments
 (0)