Technical documentation #11
Description
Technical documentation
This backlog issue lists all the components that should appear and be written in the technical documentation.
- Project init with Gradle/Maven, Swing + ANTLR (+ JUnit) #6
- Why did we choose this stack
- Write tests on how easy code samples should look like after conversion #7
- How did we write the tests
- How to ensure that they are corrects
- Barebone UI (Texts fields and run button) #9
- MVC UML Diagram
- Sequence diagram from user interaction towards how to call our custom package ANTLR
- Scheme reprensenting how the UI is divided by Swing components
- Scheme showing the app displayed and what listener is bound to which UI element
- Analyze ANTLR Java package usage #8
- Introduction to and How visitor and listener patterns are used in our app
- What does ANTLR allows us to do
- Define a custom grammar #10
- How was it thought
- How to use it
- Write examples in a markdown file