Skip to content

Commit

Permalink
P full struct
Browse files Browse the repository at this point in the history
  • Loading branch information
BryanAbate committed Jun 15, 2019
1 parent c2dfb69 commit 474c103
Show file tree
Hide file tree
Showing 5 changed files with 132 additions and 5 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -113,3 +113,5 @@ tastydoc/report/presentation/presentation\.synctex\.gz
tastydoc/report/presentation/presentation\.toc

tastydoc/dotty-0\.15\.0-RC1/

tastydoc/report/presentation/presentation\.vrb
Binary file modified tastydoc/report/presentation/presentation.pdf
Binary file not shown.
132 changes: 128 additions & 4 deletions tastydoc/report/presentation/presentation.tex
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
\documentclass{beamer}


\usepackage{listings}
\usepackage[utf8]{inputenc}
%\usetheme{CambridgeUS}
%\usefonttheme{professionalfonts}
\usecolortheme{beaver}

%Information to be included in the title page:
\title{Tastydoc}
\subtitle{A documentation tool for dotty using Tasty files}
\subtitle{A documentation tool for dotty using TASTy files}
\author{Bryan Abate}
\date{19th June 2019}

Expand All @@ -26,10 +27,133 @@
\section{Introduction}

\begin{frame}
\frametitle{Sample frame title}
This is a text in the first frame. This is a text in the first frame. This is a text in the first frame.
\frametitle{What is Tastydoc ?}
\begin{itemize}
\item Documentation tool for Dotty \pause
\item Uses TASTy files \pause
\item Outputs Markdown
\end{itemize}
\end{frame}

\section{Features}

\begin{frame}
\frametitle{Accessible information}
\begin{itemize}
\item
\end{itemize}
\end{frame}

\begin{frame}
\frametitle{TASTy}
\begin{itemize}
\item
\end{itemize}
\end{frame}

\begin{frame}
\frametitle{Linking}
\begin{itemize}
\item
\end{itemize}
\end{frame}

\begin{frame}
\frametitle{Markdown}
\begin{itemize}
\item
\end{itemize}
\end{frame}

\section{Architecture}

\begin{frame}
\frametitle{Representation}
\begin{itemize}
\item
\end{itemize}
\end{frame}

\begin{frame}
\frametitle{Reference}
\begin{itemize}
\item
\end{itemize}
\end{frame}

\begin{frame}
\frametitle{User documentation}
\begin{itemize}
\item
\end{itemize}
\end{frame}

\begin{frame}
\frametitle{Workflow}
\begin{itemize}
\item
\end{itemize}
\end{frame}

\section{Dottydoc vs Tastydoc}

\begin{frame}
\frametitle{General comparison}
\begin{itemize}
\item Compiler internals \pause
\item Markdown vs HTML/CSS
\end{itemize}
\end{frame}

\begin{frame}
\frametitle{Extra features}
\begin{itemize}
\item Scope modifiers \pause
\item Known subclasses
\end{itemize}
\end{frame}

\begin{frame}[fragile]
\frametitle{Bugs fixed}
\begin{itemize}
\item Buggy output
\begin{example}
\texttt{[31m2L[0m}
\end{example}\pause
\item Wrong parents \pause
\item Annotations \pause
\item Compiler artifacts
\end{itemize}
\end{frame}

\section{Problems \& Further work}

\begin{frame}
\frametitle{Problems}
\begin{itemize}
\item Markdown escaping \pause
\item Linking inside code blocks \pause
\item Section \pause
\item IDs for linking
\end{itemize}
\end{frame}

\begin{frame}[fragile]
\frametitle{Further work}
\begin{itemize}
\item Markdown escaping \pause
\item Type lambdas \pause
\item Complex types
\begin{lstlisting}[language=scala]
class Graph {
type Node = Int
}
def linkingGraph(g: Graph): g.Node = ???
\end{lstlisting}\pause
\item Default values \pause
\item Extra user-documentation parsing \pause
\item HTML/CSS
\end{itemize}
\end{frame}

\end{document}
Binary file modified tastydoc/report/report.pdf
Binary file not shown.
3 changes: 2 additions & 1 deletion tastydoc/report/report.tex
Original file line number Diff line number Diff line change
Expand Up @@ -305,4 +305,5 @@ \chapter{Remaining work}
\end{document}

%Say that dottydoc does not have these features in problems?
% Dottydoc no companion, not true?
% Dottydoc no companion, not true?
% Move Md to features from arch?

0 comments on commit 474c103

Please sign in to comment.