Skip to content

Commit 53571a9

Browse files
BryanAbateabgruszecki
authored andcommitted
P update
1 parent ece0d5e commit 53571a9

File tree

4 files changed

+35
-9
lines changed

4 files changed

+35
-9
lines changed
Loading
Loading
45.2 KB
Binary file not shown.

tastydoc/report/presentation/presentation.tex

Lines changed: 35 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,20 +30,26 @@
3030
}
3131
\usepackage[utf8]{inputenc}
3232
\usepackage{graphicx}
33+
\beamertemplatenavigationsymbolsempty
3334
%\usetheme{CambridgeUS}
3435
%\usefonttheme{professionalfonts}
3536
\usecolortheme{beaver}
3637

3738
%Information to be included in the title page:
3839
\title{Tastydoc}
39-
\subtitle{A documentation tool for dotty using TASTy files}
40+
\subtitle{A documentation tool for Dotty using TASTy files}
4041
\author{Bryan Abate}
4142
\date{19th June 2019}
4243

4344
\begin{document}
4445

4546
\frame{\titlepage}
4647

48+
\begin{frame}
49+
\frametitle{Table of Contents}
50+
\tableofcontents
51+
\end{frame}
52+
4753
\AtBeginSection[]
4854
{
4955
\begin{frame}
@@ -55,18 +61,20 @@
5561
\section{Introduction}
5662

5763
\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}
6471
\end{frame}
6572

6673
\section{Features}
6774

6875
\begin{frame}
6976
\frametitle{Accessible information}
77+
\pause
7078
\begin{itemize}
7179
\item Annotations, modifiers (including scope modifiers), parameters, type parameters, and return types \pause
7280
\item Members, parents, constructors, known subclasses and companion \pause
@@ -76,6 +84,7 @@ \section{Features}
7684

7785
\begin{frame}
7886
\frametitle{TASTy}
87+
\pause
7988
\begin{itemize}
8089
\item Extract information from them \pause
8190
\item Independent from the compiler
@@ -84,6 +93,7 @@ \section{Features}
8493

8594
\begin{frame}
8695
\frametitle{Linking}
96+
\pause
8797
\begin{itemize}
8898
\item To types \pause
8999
\item Companion \pause
@@ -95,11 +105,12 @@ \section{Features}
95105

96106
\begin{frame}
97107
\frametitle{Markdown}
108+
\pause
98109
\begin{itemize}
99110
\item Easy to edit by hand \& preview \pause
100111
\item Easy to add own files \pause
101112
\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
103114
\item Easy to convert to another format (HTML, PDF, etc.)
104115
\end{itemize}
105116
\end{frame}
@@ -113,6 +124,12 @@ \section{Examples}
113124
\end{center}
114125
\end{frame}
115126

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}
116133
\begin{frame}
117134
\frametitle{Example: scalaShadowing.language}
118135
\begin{center}
@@ -124,6 +141,7 @@ \section{Architecture}
124141

125142
\begin{frame}
126143
\frametitle{Representation}
144+
\pause
127145
\begin{itemize}
128146
\item Contain information about an entity \pause
129147
\item Easy to use, no knowledge of TASTy required \pause
@@ -134,6 +152,7 @@ \section{Architecture}
134152

135153
\begin{frame}
136154
\frametitle{Reference}
155+
\pause
137156
\begin{itemize}
138157
\item Contain information about types \pause
139158
\item Necessary for linking \pause
@@ -143,6 +162,7 @@ \section{Architecture}
143162

144163
\begin{frame}[fragile]
145164
\frametitle{User documentation}
165+
\pause
146166
\begin{itemize}
147167
\item Access to all @ except \texttt{@usecase} and \texttt{@define}\pause
148168
\item Support Wiki-style and Markdown \pause
@@ -156,6 +176,7 @@ \section{Architecture}
156176

157177
\begin{frame}
158178
\frametitle{Workflow}
179+
\pause
159180
\begin{center}
160181
\begin{tikzpicture}[node distance=2cm]
161182
\node (parse) [process] {Parse command line arguments};\pause
@@ -172,6 +193,7 @@ \section{Dottydoc vs Tastydoc}
172193

173194
\begin{frame}
174195
\frametitle{General comparison}
196+
\pause
175197
\begin{itemize}
176198
\item Compiler internals \pause
177199
\item Markdown vs HTML/CSS
@@ -180,6 +202,7 @@ \section{Dottydoc vs Tastydoc}
180202

181203
\begin{frame}
182204
\frametitle{Extra features}
205+
\pause
183206
\begin{itemize}
184207
\item Scope modifiers \pause
185208
\item Known subclasses \pause
@@ -189,6 +212,7 @@ \section{Dottydoc vs Tastydoc}
189212

190213
\begin{frame}[fragile]
191214
\frametitle{Bugs fixed}
215+
\pause
192216
\begin{itemize}
193217
\item Buggy output
194218
\begin{lstlisting}
@@ -208,16 +232,18 @@ \section{Problems \& Further work}
208232

209233
\begin{frame}
210234
\frametitle{Problems}
235+
\pause
211236
\begin{itemize}
212237
\item Markdown escaping \pause
213238
\item Linking inside code blocks \pause
214-
\item Section \pause
239+
\item Sections \pause
215240
\item IDs for linking
216241
\end{itemize}
217242
\end{frame}
218243

219244
\begin{frame}[fragile]
220245
\frametitle{Further work}
246+
\pause
221247
\begin{itemize}
222248
\item Markdown escaping \pause
223249
\item Type lambdas \pause

0 commit comments

Comments
 (0)