smyalygames/checklist-tester
1
0
Fork 0
mirror of https://github.com/smyalygames/checklist-tester.git synced 2025-05-18 14:34:12 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

refactor(dissertation): change ref to autoref

Browse Source
This commit is contained in:
Anthony Berg 2024-05-15 22:22:59 +01:00
parent e729ac129f
commit 114a7e745d
4 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
pub/dissertation/chapters/design.tex
View File

@ -28,7 +28,7 @@ Splitting up the project into multiple components has been useful for
\caption{Abstract layout of components} \caption{Abstract layout of components}
\end{figure} \end{figure}
Each of the components in Figure~\ref{fig:abstract} will be covered in detail in this Each of the components in \autoref{fig:abstract} will be covered in detail in this
chapter. chapter.
@ -69,7 +69,7 @@ Brief overview of what it is supposed to do... % TODO
\item Allows to think about making parts of the GUI modular and what components can be reused \item Allows to think about making parts of the GUI modular and what components can be reused
\end{itemize} \end{itemize}
\item Figma allows for plugins such as Material 3 colours and Material 3 components \item Figma allows for plugins such as Material 3 colours and Material 3 components
\item Figure~\ref{fig:figma-gui} is the final design that will be used for the \item \autoref{fig:figma-gui} is the final design that will be used for the
program program
\end{itemize} \end{itemize}
@ -84,12 +84,12 @@ Brief overview of what it is supposed to do... % TODO
\begin{itemize} \begin{itemize}
\item The Material 3 Components in Figma do not include features that are available in \item The Material 3 Components in Figma do not include features that are available in
Jetpack Compose Jetpack Compose
\item In this project, the \enquote{Simulator Test} at the bottom of Figure~\ref{fig:figma-gui} \item In this project, the \enquote{Simulator Test} at the bottom of \autoref{fig:figma-gui}
does not include a leading icon~\cite{material:lists}, and therefore had to be a trailing does not include a leading icon~\cite{material:lists}, and therefore had to be a trailing
checkbox checkbox
\item This was overcome by adding comments in Figma as a reminder of how the actual implementation \item This was overcome by adding comments in Figma as a reminder of how the actual implementation
should be like should be like
\item Another limitation is that in Figure~\ref{fig:figma-gui}, the title of the screen in the \item Another limitation is that in \autoref{fig:figma-gui}, the title of the screen in the
top app bar~\cite{material:top-app-bar} is not centered, and that is because the auto layout top app bar~\cite{material:top-app-bar} is not centered, and that is because the auto layout
feature in Figma allows for equal spacing, rather than having each in a set position feature in Figma allows for equal spacing, rather than having each in a set position
\end{itemize} \end{itemize}
@ -105,7 +105,7 @@ Brief overview of what it is supposed to do... % TODO
components, otherwise a nested mess would occur as Compose is designed to have components, otherwise a nested mess would occur as Compose is designed to have
Composable functions passed in to a Composable function and therefore by design Composable functions passed in to a Composable function and therefore by design
function nests will occur and the code will be harder to read if not managed correctly. function nests will occur and the code will be harder to read if not managed correctly.
Listing~\ref{list:compose-modular} shows example of using modular code \autoref{list:compose-modular} shows example of using modular code
from the Actions screen in project (with code omissions shown in comments) from the Actions screen in project (with code omissions shown in comments)
\item Used Voyager~\cite{voyager} to handle screens \item Used Voyager~\cite{voyager} to handle screens
\item Used Koin~\cite{koin} for dependency injection, to be able to get data from the \item Used Koin~\cite{koin} for dependency injection, to be able to get data from the
@ -229,7 +229,7 @@ Brief overview of what it is supposed to do... % TODO
\begin{itemize} \begin{itemize}
\item The design of the database had relationships in mind as the goal was to \item The design of the database had relationships in mind as the goal was to
have a detailed tracking of statistics for each step in the procedure, have a detailed tracking of statistics for each step in the procedure,
hence in Figure~\ref{fig:db-erd} hence in \autoref{fig:db-erd}
\item A \textit{Procedure} can have multiple \textit{Tests}, where each \textit{Test} \item A \textit{Procedure} can have multiple \textit{Tests}, where each \textit{Test}
each contains the result of how each \textit{Action} in \textit{ActionResults} each contains the result of how each \textit{Action} in \textit{ActionResults}
\item The choice of a \textit{Project} was to allow for the segregation of testing \item The choice of a \textit{Project} was to allow for the segregation of testing

BIN
pub/dissertation/dissertation.pdf
View File

Binary file not shown.

2
pub/dissertation/dissertation.sum
View File

@ -1 +1 @@
2627 2621

2
pub/dissertation/dissertation.tex
View File

@ -21,6 +21,8 @@
} }
} }
\providecommand*{\listingautorefname}{Listing}
% Taken from vdmlisting % Taken from vdmlisting
\lstdefinelanguage{VDM_SL} \lstdefinelanguage{VDM_SL}
{morekeywords={RESULT,\#else,\#endif,\#ifdef,\#ifndef,abs,all,always,and,as,atomic,be,be st,bool,by,card,cases,char,comp,compose,conc,dcl,def,definitions,dinter,div,dlmodule,do,dom,dunion, {morekeywords={RESULT,\#else,\#endif,\#ifdef,\#ifndef,abs,all,always,and,as,atomic,be,be st,bool,by,card,cases,char,comp,compose,conc,dcl,def,definitions,dinter,div,dlmodule,do,dom,dunion,