updated README

main
Philipp3107 2022-12-09 11:06:43 +01:00
parent 96313208b3
commit 2aafdb2a7a
1 changed files with 99 additions and 90 deletions

187
README.md
View File

@ -17,18 +17,30 @@
# Overview # Overview
## Packages ## Packages
* [Domain](#domain) * ### [Domain](#domain)
* [R2D2](#-klasse-r2d2-) * [R2D2](#-klasse-r2d2-)
* [R2D2Test](#-testklasse-r2d2test-) * [R2D2Test](#-testklasse-r2d2test-)
* [C3P0](#-klasse-c3po-) * [C3P0](#-klasse-c3po-)
* [C3POTest](#-testklasse-c3potest-)
* [RobotBasics]
* [Robot](#-interface-robot-) * [Robot](#-interface-robot-)
* [RobotControl](#-interface-robotcontrol-) * [RobotControl](#-interface-robotcontrol-)
* [RobotControl](#-interface-robotinstructions-) * [RobotControl](#-interface-robotinstructions-)
* [Facade](#facade) * ### [Facade](#facade)
* [Factrory](#-klasse-factory-) * [Factrory](#-klasse-factory-)
* [Infrastructure](#infratructure) * ### [Infrastructure](#infratructure)
* [Persistenz](#-klasse-persistenz-) * [Persistenz](#-klasse-persistenz-)
* [UI](#ui) * ### [robot]
* ### [exceptions]
* [RobotException]
* [RobotIllegalStateException]
* [RobotMagicValueException]
* ### [interfaces](#-interfaces-)
* [Robot]
* [RobotControl]
* [RobotInstructions]
* [Sorting] vorläufig
* ### [UI](#ui)
## Sidefiles ## Sidefiles
* [Main](#-klasse-main-) * [Main](#-klasse-main-)
@ -38,81 +50,52 @@
<h2 align="center"> Klasse R2D2 </h2> <h2 align="center"> Klasse R2D2 </h2>
### Variables: ### Variables:
``` `--not set yet--`
private int id
private String name
private boolean power
```
___ ___
### Methods: ### Methods:
``` `public R2D2():R2D2`
public R2D2():R2D2
//implemented from interface Robotcontrol
public getId():int
public getName():String
public triggerPowerSWitch():void
public isPowerOn():boolean
```
<h2 align="center"> TestKlasse R2D2Test </h2> <h2 align="center"> TestKlasse R2D2Test </h2>
### Variables: ### Variables:
```
public int id `public int id`
public String name
public R2D2 Herbert `public String name`
```
`public R2D2 Herbert`
___ ___
### Methods: ### Methods:
```
@BeforeEach
setup():void
@Test `@BeforeEach`
getId():void `setup():void`
getName():void
triggerPowerSwitch():void `@Test`
iPowerOn():void
`getId():void`
`getName():void`
`triggerPowerSwitch():void`
`iPowerOn():void`
```
<h2 align="center"> Klasse C3PO </h2> <h2 align="center"> Klasse C3PO </h2>
### Variables: ### Variables:
``` `--not set yet--`
--not set yet--
```
___ ___
### Methods: ### Methods:
``` `//construtor`
--not set yet--
```
<h2 align="center"> Interface Robot </h2> `public C3PO(): C3PO`
### Methods:
```
--not set yet--
```
<h2 align="center"> Interface RobotControl </h2>
### Methods:
```
--not set yet--
```
<h2 align="center"> Interface RobotInstructions </h2>
### Methods:
```
--not set yet--
```
## facade ## facade
@ -120,73 +103,99 @@ ___
<h2 align="center"> Klasse Factory </h2> <h2 align="center"> Klasse Factory </h2>
### Variables: ### Variables:
``` `--not set yet--`
--not set yet--
```
___ ___
### Methods: ### Methods:
``` `--not set yet--`
--not set yet--
```
## Infrastructure ## Infrastructure
<h2 align="center"> Klasse Persistenz </h2> <h2 align="center"> Klasse Persistenz </h2>
### Variables: ### Variables:
``` `--not set yet--`
--not set yet--
```
___ ___
### Methods: ### Methods:
``` `--not set yet--`
--not set yet--
``` ## robot
### exceptions
<h2 align="center"> Class RobotException </h2>
### Methods:
`public RobotException():Exception`
<h2 align="center"> Class RobotIllegalStateException </h2>
### Methods:
`public RobotIllegalStateException():RobotException`
<h2 align="center"> Class RobotMagicValueException </h2>
### Methods:
`public RobotMagicValueException():RobotException`
### interfaces
<h2 align="center"> Interface Robot </h2>
### Methods:
`--not set yet--`
<h2 align="center"> Interface RobotControl </h2>
### Methods:
`--not set yet--`
<h2 align="center"> Interface RobotInstructions </h2>
### Methods:
`--not set yet--`
## UI ## UI
<h2 align="center"> Klasse UI </h2> <h2 align="center"> Klasse UI </h2>
### Variables: ### Variables:
``` `--not set yet--`
--not set yet--
```
___ ___
### Methods: ### Methods:
``` `--not set yet--`
--not set yet--
```
<h2 align="center"> Klasse Main </h2> <h2 align="center"> Klasse Main </h2>
### Variables: ### Variables:
``` `--not set yet--`
--not set yet--
```
___ ___
### Methods: ### Methods:
``` `--not set yet--`
--not set yet--
```
<h2 align="center"> makefile for Git updates </h2> <h2 align="center"> makefile for Git updates </h2>
### Variables: ### Variables:
``` `--not set yet--`
--not set yet--
```
___ ___
### Methods: ### Methods:
```
update_readme: `update_readme:`
update_make:
update_all: `update_make:`
```
`update_all:`
## Aufgabe ## Aufgabe