From 0c68b9a44749b9a4c1673693a6c674b7e31ea485 Mon Sep 17 00:00:00 2001
From: Mathieu Boretti <mathieu.boretti@gmail.com>
Date: Mon, 1 Jun 2020 20:06:04 +0200
Subject: [PATCH] Issue #331 - Add more javadoc

---
 .../extensions/matchers/package-info.java     | 22 +++++++++++++++++--
 1 file changed, 20 insertions(+), 2 deletions(-)

diff --git a/src/main/java/ch/powerunit/extensions/matchers/package-info.java b/src/main/java/ch/powerunit/extensions/matchers/package-info.java
index 076268c18..ff9541bc9 100644
--- a/src/main/java/ch/powerunit/extensions/matchers/package-info.java
+++ b/src/main/java/ch/powerunit/extensions/matchers/package-info.java
@@ -21,11 +21,29 @@
 /**
  * Annotations to be used to generate <i>hamcrest</i> Matchers based on this
  * annotation provider.
+ * <hr>
+ * <p>
+ * <b>Metadata</b>
+ * <p>
+ * Since version 0.2.0, a metadata section is part of the generated matcher. The
+ * format of these metadatas may change and is considered as an internal feature
+ * and not a public feature, but this can be used for debugging and this used by
+ * the annotation processor itself to detect the compatibility of existing
+ * matchers.
+ * <p>
+ * The essential attribute is the
+ * <code>COMPATIBILITY</code> attribute of the class <code>Metadata</code>
+ * (referenced from the static field <code>METADATA</code>) which exposes an
+ * encoded long with the compatibility information regarding this matcher.
+ * <p>
+ * The <code>ANNOTATION_PROCESSOR_VERSION </code> may be used to find the
+ * version of the annotation processor used to generate the class.
  * 
  * @author borettim
  * 
- * @see ch.powerunit.extensions.matchers.ProvideMatchers <code>@ProvideMatchers</code>&nbsp;- the annotation to be used
- *      on class that must be processed by this annotation processor.
+ * @see ch.powerunit.extensions.matchers.ProvideMatchers
+ *      <code>@ProvideMatchers</code>&nbsp;- the annotation to be used on class
+ *      that must be processed by this annotation processor.
  *
  */
 package ch.powerunit.extensions.matchers;
\ No newline at end of file