Issue #316 - Documentation

pom.xml

@@ -366,7 +366,7 @@
 					</execution>
 				</executions>
 				<configuration>
-					<excludePackageNames>ch.powerunit.extensions.matchers.factoryprocessor*:ch.powerunit.extensions.matchers.provideprocessor*:ch.powerunit.extensions.matchers.common*</excludePackageNames>
+					<excludePackageNames>ch.powerunit.extensions.matchers.provideprocessor:ch.powerunit.extensions.matchers.common:ch.powerunit.extensions.matchers.provideprocessor*:ch.powerunit.extensions.matchers.common*</excludePackageNames>
 					<docfilessubdirs>true</docfilessubdirs>
 					<linksource>false</linksource>
 					<detectLinks />
@@ -635,7 +635,7 @@
 				<artifactId>maven-javadoc-plugin</artifactId>
 				<version>3.2.0</version>
 				<configuration>
-					<excludePackageNames>ch.powerunit.extensions.matchers.factoryprocessor*:ch.powerunit.extensions.matchers.provideprocessor*:ch.powerunit.extensions.matchers.common*</excludePackageNames>
+					<excludePackageNames>ch.powerunit.extensions.matchers.provideprocessor:ch.powerunit.extensions.matchers.common:ch.powerunit.extensions.matchers.provideprocessor*:ch.powerunit.extensions.matchers.common*</excludePackageNames>
 					<docfilessubdirs>true</docfilessubdirs>
 					<linksource>true</linksource>
 					<detectLinks />

src/main/java/ch/powerunit/extensions/matchers/ProvideMatchers.java

@@ -30,8 +30,8 @@
  * This annotation can be used on a java class, to mark this class as supporting
  * generation of hamcrest matcher.
  * <p>
- * <b>This annotation is not supported on interface and enum. A warning will be
- * displayed in this case.</b>
+ * <b>This annotation is not supported on interface and enum. A error will be
+ * generated in this case.</b>
  * <p>
  * This annotation is processed by an annotation processor, in order to generate
  * :
@@ -200,6 +200,27 @@
  * <li>If <a href="https://github.com/orien/bean-matchers">Bean Matchers</a> is
  * available additional method to validate Class field.</li>
  * </ul>
+ * <hr>
+ * <p>
+ * <b>Linking between matchers</b>
+ * <p>
+ * The annotation processor try to link the generated matchers. The goal is that
+ * when a field or the super class also have a matchers, this one is used. It is
+ * not always possible to link everything but the concept is the following :
+ * <ul>
+ * <li>If the super class is compiled at the same time and is annotated with
+ * this annotation, the annotation processor may add a control on the parent and
+ * generated chaining method.</li>
+ * <li>If a field class is compiled at the same time and is annotated with this
+ * annotation, the annotation processor may add chaining and dedicated control
+ * that use this matcher.</li>
+ * <li>If a matcher, following the convention of this framework is detected for
+ * the super class or a field (already compiled for example), the annotation
+ * processor may also apply the previous rules by using this detected
+ * matcher.</li>
+ * <li>The annotation processor may also try to find matcher for element of Map,
+ * List, Array.</li>
+ * </ul>
  * 
  * @author borettim
  *

src/main/java/ch/powerunit/extensions/matchers/package-info.java

@@ -19,6 +19,9 @@
  */
 
 /**
+ * Annotations to be used to generate <i>hamcrest</i> Matchers based on this
+ * annotation provider.
+ * 
  * @author borettim
  *
  */