Browse Source

Update documentation

dependabot/maven/junit-junit-4.13.1
Malte Schmitz 8 years ago
parent
commit
b46305c1d9
2 changed files with 28 additions and 4 deletions
  1. +27
    -3
      README.md
  2. +1
    -1
      src/main/java/interpreter/Visitor.java

+ 27
- 3
README.md View File

@@ -18,9 +18,33 @@ while (a) {

## Literate Programming Documentation

The code is documented in a literate programming style using [Atlassian Docco](https://bitbucket.org/doklovic_atlassian/atlassian-docco)

Have a look a the [Parser](https://malteschmitz.github.io/WhileInterpreter/docco/vertical/src/main/java/parser/Parser.java.html) and the [Interpreter](https://malteschmitz.github.io/WhileInterpreter/docco/vertical/src/main/java/interpreter/Interpreter.java.html) where the formal syntax and semantics are defined, too.
The code is documented in a literate programming style using [Atlassian Docco](https://bitbucket.org/brainicorn/atlassian-docco)

- **Expression**
- [Addition.java](https://malteschmitz.github.io/WhileInterpreter/docco/vertical/src/main/java/expression/Addition.java.html)
- [Expression.java](https://malteschmitz.github.io/WhileInterpreter/docco/vertical/src/main/java/expression/Expression.java.html)
- [Identifier.java](https://malteschmitz.github.io/WhileInterpreter/docco/vertical/src/main/java/expression/Identifier.java.html)
- [Int.java](https://malteschmitz.github.io/WhileInterpreter/docco/vertical/src/main/java/expression/Int.java.html)
- [Subtraction.java](https://malteschmitz.github.io/WhileInterpreter/docco/vertical/src/main/java/expression/Subtraction.java.html)
- **Interpreter**
- [Evaluator.java](https://malteschmitz.github.io/WhileInterpreter/docco/vertical/src/main/java/interpreter/Evaluator.java.html)
- [Interpreter.java](https://malteschmitz.github.io/WhileInterpreter/docco/vertical/src/main/java/interpreter/Interpreter.java.html)
- [InterpreterException.java](https://malteschmitz.github.io/WhileInterpreter/docco/vertical/src/main/java/interpreter/InterpreterException.java.html)
- [Visitor.java](https://malteschmitz.github.io/WhileInterpreter/docco/vertical/src/main/java/interpreter/Visitor.java.html)
- **Parser**
- [Parser.java](https://malteschmitz.github.io/WhileInterpreter/docco/vertical/src/main/java/parser/Parser.java.html)
- [SyntaxException.java](https://malteschmitz.github.io/WhileInterpreter/docco/vertical/src/main/java/parser/SyntaxException.java.html)
- **Printer**
- [ExpressionPrinter.java](https://malteschmitz.github.io/WhileInterpreter/docco/vertical/src/main/java/printer/ExpressionPrinter.java.html)
- [ProgramPrinter.java](https://malteschmitz.github.io/WhileInterpreter/docco/vertical/src/main/java/printer/ProgramPrinter.java.html)
- **Program**
- [Assignment.java](https://malteschmitz.github.io/WhileInterpreter/docco/vertical/src/main/java/program/Assignment.java.html)
- [Composition.java](https://malteschmitz.github.io/WhileInterpreter/docco/vertical/src/main/java/program/Composition.java.html)
- [Conditional.java](https://malteschmitz.github.io/WhileInterpreter/docco/vertical/src/main/java/program/Conditional.java.html)
- [Loop.java](https://malteschmitz.github.io/WhileInterpreter/docco/vertical/src/main/java/program/Loop.java.html)
- [Program.java](https://malteschmitz.github.io/WhileInterpreter/docco/vertical/src/main/java/program/Program.java.html)

Start with the [Parser](https://malteschmitz.github.io/WhileInterpreter/docco/vertical/src/main/java/parser/Parser.java.html) and the [Interpreter](https://malteschmitz.github.io/WhileInterpreter/docco/vertical/src/main/java/interpreter/Interpreter.java.html) where the formal syntax and semantics of the _while prorgrams_ are defined.

## Building



+ 1
- 1
src/main/java/interpreter/Visitor.java View File

@@ -17,7 +17,7 @@ package interpreter;


/*! This `Visitor` is implemented using
[Reflection](https://en.wikipedia.org/wiki/Reflection_(computer_programming)). That is kind of cheating, but simplifies
[Reflection](http://www.oracle.com/technetwork/articles/java/javareflection-1536171.html). That is kind of cheating, but simplifies
the classical Visitor pattern a lot. Of course the performance is bad, but performance is not an issue in this little
demonstration and actually there are a lot of other performance issues as well. */
public abstract class Visitor<T> {


Loading…
Cancel
Save