small amendments

JueRei · Sep 15, 2020 · e227608 · e227608
1 parent 6cc3bfb
commit e227608
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 5 deletions.
diff --git a/History.md b/History.md
@@ -1,8 +1,9 @@
 ## 2.0 
 ### done
 
-- remove jaxb
-- 2.1 now default
+- support for ZF 2.1.1, i.e. "Reference profile" Xrechnung 
+- ZF 2.1.1 now default (up to 1.7.8 ZF2 could be set but ZF1 was default)
+- removed jaxb
 - pushprovider
 - new xrechnung profile
 - german bank account numbers can no longer be specified (dropped in favor of IBAN and BIC)
@@ -54,6 +55,9 @@ switch
 - *USt 0% wird aus invoice-klasse noch nicht sauber abgefangen
 - new features additional docs, contract id, periods, corrected invoices, discounts, occurrence dates and periods
 
+Alpha2 2020-09-15
+Alpha1 2020-08-06
+
 Mustangproject 1.7.8
 =====
 2020-06-14

diff --git a/Mustang-CLI/src/main/java/org/mustangproject/commandline/Main.java b/Mustang-CLI/src/main/java/org/mustangproject/commandline/Main.java
@@ -642,7 +642,7 @@ private static void performVisualization(String sourceName, String outName) {
 	 *
 	 * @param resourceName ie.: "/SmartLibrary.dll"
 	 * @return The path to the exported resource
-	 * @throws Exception
+	 * @throws Exception e.g. if the specified resource does not exist at the specified location
 	 */
 	static public String ExportResource(String resourceName) throws Exception {
 		InputStream stream = null;

diff --git a/doc/development_documentation.md b/doc/development_documentation.md
@@ -3,7 +3,7 @@
 
 1. build
 
-as excercise to check if the neccessary tools are there, the build is in a stable state and works on your platform, e.g. download and extract https://github.com/ZUGFeRD/mustangproject/archive/master.zip and run ./mvnw clean package
+To check if the necessary tools are there, the build is in a stable state and works on your platform, e.g. download and extract https://github.com/ZUGFeRD/mustangproject/archive/master.zip and run ./mvnw clean package
 
 Mvnw is a maven wrapper which will download maven.Maven is the dependency management tool which will download all libraries, their dependencies, and build the whole thing.
 
@@ -27,6 +27,19 @@ If you do a pull request, please do a feature branch, e.g. if you are working on
 Most of mustang is a library, adding (autmated junit) test cases is often not only the most sustainable but also the fastest way to see if new/changed functionality works. If something is changed so that old test cases break on purpose please do not just remove them but take the time to fix the test cases
 
 
+## Architecture
+
+Mustang contains a library to read/write e-invoices, 
+a validator library  
+(and can also read/write e-invoices, but is substantially 
+larger) and a commandline application using the latter 
+library.
+
+The validator component embeds VeraPDF, a open-source
+PDF/A-validator, via maven dependency and uses ph-schematron 
+to validate the XML part of the invoices.
+
+![architecture of the validator](ZUV-Architektur.svg "Graph of the architecture of the validator component")
 
 ## New build
 
@@ -46,7 +59,13 @@ can be used as debug configuration goal in Eclipse. In that case you can set bre
 
 ## Validate
 
-[ZUV](https://github.com/ZUGFeRD/ZUV/) can be used to validate generated files.
+The former ZUGFeRD VeraPDF [ZUV](https://github.com/ZUGFeRD/ZUV/) validator
+is now part of Mustangproject. 
+The JUnit tests of the validator component will also run through a couple of
+test files of the library component.
+
+
+
 
 ## Deployment