BOSWatch/BW3-Core
1
0
Fork 0
mirror of https://github.com/BOSWatch/BW3-Core.git synced 2026-01-15 05:00:07 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

edit _gen/readme

Browse source
This commit is contained in:
Bastian Schroll 2018-01-05 18:19:12 +01:00
parent af9a79193b
commit 620d848b4c
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
_gen/readme.md
View file

@ -2,12 +2,15 @@
Im Verzeichnis `_gen/` befinden sich Windows Batch-Scripte um bestimmt Aufgaben zu
vereinfachen und zu automatisieren.
---
### cloc.bat
CLoC steht für `Count Lines of Code`
`CLoC` steht für Count Lines of Code
Dieses Tool erstellt einen kurzen Report über die Anzahl der Dateien, Codezeilen,
Kommentare und Leerzeilen sortiert nach jeweiliger Programmiersprache
---
### doxygen.bat
Doxygen ist ein Dokumentationswerkzeug zum automatischen dokumentieren von Quellcode.
@ -15,8 +18,9 @@ Doxygen ist ein Dokumentationswerkzeug zum automatischen dokumentieren von Quell
Nach dem ausführen wird der gesamte Quellcode geparst und eine HTML Dokumentation
im Verzeichnis `_docu/html/` angelegt.
Die Konfigurations Datei für Doxygen findet sich unter `_config/doxygen.ini`
Die Konfigurations Datei für Doxygen findet sich unter `_gen/doxygen.ini`
---
### pytest.bat
pytest ist ein Python Testframework
@ -37,4 +41,4 @@ der Code-Sytel Vorgaben von Python hin untersucht und etwaige Fehler ausgegeben.
Vom Testverlauf wird ein Logfile erstellt welches in `log/test.log` befindet.
Die Konfigurationsdatei für pytest findet sich unter `_config/pytest.ini`
Die Konfigurationsdatei für pytest findet sich unter `_gen/pytest.ini`