Improve docs for future me

Author: veewee

README.md

@@ -66,7 +66,7 @@ The result of this loader is a completely flattened WSDL file which you can e.g.
 use Soap\Wsdl\Loader\FlatteningLoader;
 use Soap\Wsdl\Loader\StreamWrapperLoader;
 
-$loader = FlatteningLoader::createForLoader(new StreamWrapperLoader());
+$loader = new FlatteningLoader(new StreamWrapperLoader());
 
 $contents = $loader($wsdl);
 ```

psalm.xml

@@ -22,5 +22,6 @@
     </projectFiles>
     <ignoreExceptions>
         <class name="InvalidArgumentException" />
+        <class name="Psl\Exception\InvariantViolationException" />
     </ignoreExceptions>
 </psalm>

src/Xml/Configurator/FlattenTypes.php

@@ -15,6 +15,10 @@
 use function VeeWee\Xml\Dom\Manipulator\append;
 use function VeeWee\Xml\Dom\Manipulator\Node\remove;
 
+/**
+ * This class transforms multiple wsdl:types elements into 1 single element.
+ * This makes importing xsd's easier (and prevents some bugs in some soap related tools)
+ */
 final class FlattenTypes implements Configurator
 {
     /**

src/Xml/Configurator/FlattenXsdImports.php

@@ -7,7 +7,6 @@
 use DOMDocument;
 use DOMElement;
 use DOMNode;
-use Psl\Exception\InvariantViolationException;
 use Psl\Type\Exception\AssertException;
 use Soap\Wsdl\Exception\UnloadableWsdlException;
 use Soap\Wsdl\Loader\Context\FlatteningContext;
@@ -25,10 +24,8 @@
 use function VeeWee\Xml\Dom\Manipulator\Node\remove;
 
 /**
- * @TODO check https://github.com/pkielgithub/SchemaLightener/blob/master/src/SchemaLightener.java implementation
- * -> http://www.strategicdevelopment.io/tools/index.php
- * -> http://www.strategicdevelopment.io/tools/SchemaLightener.php
- * -> http://www.strategicdevelopment.io/tools/WSDLFlattener.php
+ * This class deals with xsd:import, xsd:include and xsd:redefine tags.
+ * It imports the types grouped by schema namespace to make sure that the size of the result is as small as possible!
  */
 final class FlattenXsdImports implements Configurator
 {
@@ -176,7 +173,6 @@ private function loadSchema(string $location): ?DOMElement
      * It groups all imports by targetNamespace.
      *
      * @throws RuntimeException
-     * @throws InvariantViolationException
      * @throws AssertException
      */
     private function registerSchemaInTypes(DOMElement $schema): void