30
30
}
31
31
\usepackage [utf8 ]{inputenc }
32
32
\usepackage {graphicx }
33
+ \beamertemplatenavigationsymbolsempty
33
34
% \usetheme{CambridgeUS}
34
35
% \usefonttheme{professionalfonts}
35
36
\usecolortheme {beaver}
36
37
37
38
% Information to be included in the title page:
38
39
\title {Tastydoc}
39
- \subtitle {A documentation tool for dotty using TASTy files}
40
+ \subtitle {A documentation tool for Dotty using TASTy files}
40
41
\author {Bryan Abate}
41
42
\date {19th June 2019}
42
43
43
44
\begin {document }
44
45
45
46
\frame {\titlepage }
46
47
48
+ \begin {frame }
49
+ \frametitle {Table of Contents}
50
+ \tableofcontents
51
+ \end {frame }
52
+
47
53
\AtBeginSection []
48
54
{
49
55
\begin {frame }
55
61
\section {Introduction }
56
62
57
63
\begin {frame }
58
- \frametitle {What is Tastydoc ?}
59
- \begin {itemize }
60
- \item Documentation tool for Dotty \pause
61
- \item Uses TASTy files \pause
62
- \item Outputs Markdown
63
- \end {itemize }
64
+ \frametitle {What is Tastydoc ?}
65
+ \pause
66
+ \begin {itemize }
67
+ \item Documentation tool for Dotty \pause
68
+ \item Uses TASTy files \pause
69
+ \item Outputs Markdown
70
+ \end {itemize }
64
71
\end {frame }
65
72
66
73
\section {Features }
67
74
68
75
\begin {frame }
69
76
\frametitle {Accessible information}
77
+ \pause
70
78
\begin {itemize }
71
79
\item Annotations, modifiers (including scope modifiers), parameters, type parameters, and return types \pause
72
80
\item Members, parents, constructors, known subclasses and companion \pause
@@ -76,6 +84,7 @@ \section{Features}
76
84
77
85
\begin {frame }
78
86
\frametitle {TASTy}
87
+ \pause
79
88
\begin {itemize }
80
89
\item Extract information from them \pause
81
90
\item Independent from the compiler
@@ -84,6 +93,7 @@ \section{Features}
84
93
85
94
\begin {frame }
86
95
\frametitle {Linking}
96
+ \pause
87
97
\begin {itemize }
88
98
\item To types \pause
89
99
\item Companion \pause
@@ -95,11 +105,12 @@ \section{Features}
95
105
96
106
\begin {frame }
97
107
\frametitle {Markdown}
108
+ \pause
98
109
\begin {itemize }
99
110
\item Easy to edit by hand \& preview \pause
100
111
\item Easy to add own files \pause
101
112
\item Easy for the user to make links \pause
102
- \item Git hosting service have built-in preview \pause
113
+ \item Git hosting services have built-in preview \pause
103
114
\item Easy to convert to another format (HTML, PDF, etc.)
104
115
\end {itemize }
105
116
\end {frame }
@@ -113,6 +124,12 @@ \section{Examples}
113
124
\end {center }
114
125
\end {frame }
115
126
127
+ \begin {frame }
128
+ \frametitle {Example: dotty.DottyPredef}
129
+ \begin {center }
130
+ \includegraphics [width=\textwidth ,height=0.9\textheight ,keepaspectratio]{images/dottypredef.png}
131
+ \end {center }
132
+ \end {frame }
116
133
\begin {frame }
117
134
\frametitle {Example: scalaShadowing.language}
118
135
\begin {center }
@@ -124,6 +141,7 @@ \section{Architecture}
124
141
125
142
\begin {frame }
126
143
\frametitle {Representation}
144
+ \pause
127
145
\begin {itemize }
128
146
\item Contain information about an entity \pause
129
147
\item Easy to use, no knowledge of TASTy required \pause
@@ -134,6 +152,7 @@ \section{Architecture}
134
152
135
153
\begin {frame }
136
154
\frametitle {Reference}
155
+ \pause
137
156
\begin {itemize }
138
157
\item Contain information about types \pause
139
158
\item Necessary for linking \pause
@@ -143,6 +162,7 @@ \section{Architecture}
143
162
144
163
\begin {frame }[fragile]
145
164
\frametitle {User documentation}
165
+ \pause
146
166
\begin {itemize }
147
167
\item Access to all @ except \texttt {@usecase } and \texttt {@define }\pause
148
168
\item Support Wiki-style and Markdown \pause
@@ -156,6 +176,7 @@ \section{Architecture}
156
176
157
177
\begin {frame }
158
178
\frametitle {Workflow}
179
+ \pause
159
180
\begin {center }
160
181
\begin {tikzpicture }[node distance=2cm]
161
182
\node (parse) [process] {Parse command line arguments};\pause
@@ -172,6 +193,7 @@ \section{Dottydoc vs Tastydoc}
172
193
173
194
\begin {frame }
174
195
\frametitle {General comparison}
196
+ \pause
175
197
\begin {itemize }
176
198
\item Compiler internals \pause
177
199
\item Markdown vs HTML/CSS
@@ -180,6 +202,7 @@ \section{Dottydoc vs Tastydoc}
180
202
181
203
\begin {frame }
182
204
\frametitle {Extra features}
205
+ \pause
183
206
\begin {itemize }
184
207
\item Scope modifiers \pause
185
208
\item Known subclasses \pause
@@ -189,6 +212,7 @@ \section{Dottydoc vs Tastydoc}
189
212
190
213
\begin {frame }[fragile]
191
214
\frametitle {Bugs fixed}
215
+ \pause
192
216
\begin {itemize }
193
217
\item Buggy output
194
218
\ begin{lstlisting}
@@ -208,16 +232,18 @@ \section{Problems \& Further work}
208
232
209
233
\begin {frame }
210
234
\frametitle {Problems}
235
+ \pause
211
236
\begin {itemize }
212
237
\item Markdown escaping \pause
213
238
\item Linking inside code blocks \pause
214
- \item Section \pause
239
+ \item Sections \pause
215
240
\item IDs for linking
216
241
\end {itemize }
217
242
\end {frame }
218
243
219
244
\begin {frame }[fragile]
220
245
\frametitle {Further work}
246
+ \pause
221
247
\begin {itemize }
222
248
\item Markdown escaping \pause
223
249
\item Type lambdas \pause
0 commit comments