Add more javadoc for exposed test classes

diff --git a/pf4j/src/test/java/org/pf4j/test/AnotherFailTestPlugin.java b/pf4j/src/test/java/org/pf4j/test/AnotherFailTestPlugin.java
index a32a6828a7d3cc36ac841b3d3806fbb1010dbfb0..d97b32c576c527bb99c649c0b02062eef26d03b5 100644 (file)
--- a/pf4j/src/test/java/org/pf4j/test/AnotherFailTestPlugin.java
+++ b/pf4j/src/test/java/org/pf4j/test/AnotherFailTestPlugin.java
@@ -18,6 +18,9 @@ package org.pf4j.test;
 import org.pf4j.Plugin;
 
 /**
+ * A wrong {@link org.pf4j.Plugin}.
+ * It's wrong because it doesn't contain a constructor with one parameter ({@link org.pf4j.PluginWrapper} as parameter type).
+ *
  * @author Mario Franco
  */
 public class AnotherFailTestPlugin extends Plugin {

diff --git a/pf4j/src/test/java/org/pf4j/test/FailTestExtension.java b/pf4j/src/test/java/org/pf4j/test/FailTestExtension.java
index 511da42bbe262b5ce99bf13bb319f1781663789e..1ce2aa841d8863d935aec3fd46c466ddd2fe2cc4 100644 (file)
--- a/pf4j/src/test/java/org/pf4j/test/FailTestExtension.java
+++ b/pf4j/src/test/java/org/pf4j/test/FailTestExtension.java
@@ -18,6 +18,9 @@ package org.pf4j.test;
 import org.pf4j.Extension;
 
 /**
+ * A wrong {@link org.pf4j.Extension}.
+ * It's wrong because it doesn't contain a constructor with empty parameters (or only the default constructor).
+ *
  * @author Mario Franco
  */
 @Extension

diff --git a/pf4j/src/test/java/org/pf4j/test/FailTestPlugin.java b/pf4j/src/test/java/org/pf4j/test/FailTestPlugin.java
index 7545f6cf252b1c143183be6a239ec2d79b56e2ce..3a1824f3cbf4fbd4f8ef0f7a97e0eb8feadb5a05 100644 (file)
--- a/pf4j/src/test/java/org/pf4j/test/FailTestPlugin.java
+++ b/pf4j/src/test/java/org/pf4j/test/FailTestPlugin.java
@@ -16,6 +16,9 @@
 package org.pf4j.test;
 
 /**
+ * A wrong {@link org.pf4j.Plugin}.
+ * It's wrong because it doesn't extends {@link org.pf4j.Plugin}.
+ *
  * @author Mario Franco
  */
 public class FailTestPlugin {

diff --git a/pf4j/src/test/java/org/pf4j/test/TestExtension.java b/pf4j/src/test/java/org/pf4j/test/TestExtension.java
index 45c62828abf6982161e69f90b2d1e7365c5e092d..ec67b143b5b17fa557b4caa8a0ae20816d3dfd8b 100644 (file)
--- a/pf4j/src/test/java/org/pf4j/test/TestExtension.java
+++ b/pf4j/src/test/java/org/pf4j/test/TestExtension.java
@@ -18,6 +18,8 @@ package org.pf4j.test;
 import org.pf4j.Extension;
 
 /**
+ * A simple {@link Extension}. It implements {@link TestExtensionPoint}.
+ *
  * @author Mario Franco
  */
 @Extension

diff --git a/pf4j/src/test/java/org/pf4j/test/TestExtensionPoint.java b/pf4j/src/test/java/org/pf4j/test/TestExtensionPoint.java
index 3a282c792e911a9bd06582a034210ca11089cc7a..3849c92cbe0994f01c3f963fba5ed6627a3343ac 100644 (file)
--- a/pf4j/src/test/java/org/pf4j/test/TestExtensionPoint.java
+++ b/pf4j/src/test/java/org/pf4j/test/TestExtensionPoint.java
@@ -18,6 +18,8 @@ package org.pf4j.test;
 import org.pf4j.ExtensionPoint;
 
 /**
+ * A simple {@link ExtensionPoint} that contains one method ({@link #saySomething()}).
+ *
  * @author Mario Franco
  */
 public interface TestExtensionPoint extends ExtensionPoint {

diff --git a/pf4j/src/test/java/org/pf4j/test/TestPlugin.java b/pf4j/src/test/java/org/pf4j/test/TestPlugin.java
index 46cc5c0f053375212b7de2d33b8bd56a6d1c0fab..bab85b39fe6046565a8a7b7ff3632e5e0c852df3 100644 (file)
--- a/pf4j/src/test/java/org/pf4j/test/TestPlugin.java
+++ b/pf4j/src/test/java/org/pf4j/test/TestPlugin.java
@@ -19,6 +19,11 @@ import org.pf4j.Plugin;
 import org.pf4j.PluginWrapper;
 
 /**
+ * A simple {@link Plugin}.
+ *
+ * In real applications you don't need to create a plugin like this if you are not interested in lifecycle events.
+ * {@codes PF4J} will automatically create a plugin similar to this (empty / dummy) if no class plugin is specified.
+ *
  * @author Mario Franco
  */
 public class TestPlugin extends Plugin {

diff --git a/pf4j/src/test/java/org/pf4j/test/package-info.java b/pf4j/src/test/java/org/pf4j/test/package-info.java
new file mode 100644 (file)
index 0000000..bdd5723
--- /dev/null
+++ b/pf4j/src/test/java/org/pf4j/test/package-info.java
@@ -0,0 +1,6 @@
+/**
+ * Classes used to test different aspects of PF4J (plugins, extensions points, extensions).
+ *
+ * @author Decebal Suiu
+ */
+package org.pf4j.test;