edit Konzept

This commit is contained in:
Bastian Schroll 2017-02-23 07:45:46 +01:00
parent ae8a398c7b
commit 4156edf9a8

View file

@ -16,16 +16,17 @@ Verpacken der Funktionalitäten in Klassen um OOP-Grundsätze zu erreichen.
### Server:
- Empfängt die TCP Socket Pakete der einzelnen Clients
- Durch doubleFiltering fallen doppelt eingehende Alarme der Clienten sowieso raus
- Danach Filterung usw. und an call an die plugins
- Danach Filterung usw. dann call an die plugins
## Konfiguration:
### Client:
- Alle Einstellungen in INI File
- Einziges Argument beim Start des Clienten ist der Name der INI (-v -q -t sollen auch bleiben)
- So werden mehrere Sticks auf einem Rechner einfach möglich ohne BOSWatch Ordner kopieren zu müssen
### Client:
```
[Server]
IP = 127.0.0.1
@ -68,3 +69,23 @@ template = 0
- Konfigurations Datei für Plugin mit in den Plugin Ordner
- Plugin läd bei Bedarf seine Config selbst, die geht BOSWatch ja nichts an
- Aktuell wird eine ewig lange Config geladen, obwohl 90% der Plugins nicht genutzt werden
## Code Dokumentation
Dokumentiert werden sollten alle Funktion und Klassen in Doxygen gerechter Notation.
Genaue Erklärung und Bennenung der Tags in der Doxygen Hilfe
```
class Hello:
## @brief Short description.
# Longer description.
#
# @param self
# @param name Another Parameter
# @return value Returns a Value
def __init__(self, name):
dosomething(12)
def dosomething(x):
dosomethingelse
return 0
```