- Added some more documentation

- Fixed Maven Site

pom.xml

@@ -271,6 +271,16 @@
 					<artifactId>maven-project-info-reports-plugin</artifactId>
 					<version>3.5.0</version>
 				</plugin>
+				<plugin>
+					<groupId>org.apache.maven.plugins</groupId>
+					<artifactId>maven-plugin-report-plugin</artifactId>
+					<version>3.11.0</version>
+				</plugin>
+				<plugin>
+					<groupId>org.apache.maven.plugins</groupId>
+					<artifactId>maven-invoker-plugin</artifactId>
+					<version>3.6.0</version>
+				</plugin>
 				<plugin>
 					<groupId>org.apache.maven.plugins</groupId>
 					<artifactId>maven-javadoc-plugin</artifactId>
@@ -556,6 +566,14 @@
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-project-info-reports-plugin</artifactId>
 			</plugin>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-plugin-report-plugin</artifactId>
+			</plugin>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-invoker-plugin</artifactId>
+			</plugin>
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-javadoc-plugin</artifactId>

src/main/java/de/funfried/maven/plugin/zonky/StartEmbeddedPostgresMojo.java

@@ -77,6 +77,11 @@ public class StartEmbeddedPostgresMojo extends AbstractMojo {
 	@Parameter(defaultValue = "${reactorProjects}", readonly = true, required = true)
 	private List<MavenProject> reactorProjects;
 
+	/**
+	 * Starts the embedded postgres database.
+	 *
+	 * @throws MojoExecutionException if an error occurs
+	 */
 	@Override
 	public void execute() throws MojoExecutionException {
 		EmbeddedPostgres pg;

src/main/java/de/funfried/maven/plugin/zonky/StopEmbeddedPostgresMojo.java

@@ -21,6 +21,11 @@ public class StopEmbeddedPostgresMojo extends AbstractMojo {
 	@Parameter(defaultValue = "${project}", required = true, readonly = true)
 	private MavenProject project;
 
+	/**
+	 * Stops the embedded postgres database.
+	 *
+	 * @throws MojoExecutionException if an error occurs
+	 */
 	@Override
 	public void execute() throws MojoExecutionException {
 		Object obj = project.getProperties().get("zonky");

src/main/java/de/funfried/maven/plugin/zonky/utils/AlreadyStartedPolicy.java

@@ -1,6 +1,7 @@
 package de.funfried.maven.plugin.zonky.utils;
 
 /**
+ * Enum to define all options of the already started state.
  *
  * @author fbahle
  */

src/main/java/de/funfried/maven/plugin/zonky/utils/ZonkyUtil.java

@@ -8,6 +8,7 @@
 import io.zonky.test.db.postgres.embedded.EmbeddedPostgres;
 
 /**
+ * Zonky utility class.
  *
  * @author fbahle
  */

src/main/site/site.xml → src/site/site.xml

@@ -56,6 +56,7 @@
 
 		<menu name="Overview">
 			<item name="Introduction" href="index.html"/>
+			<item name="Goals" href="plugin-info.html"/>
 			<item name="Usage" href="usage.html"/>
 			<item name="Known Issues" href="known_issues.html"/>
 			<item name="Downloads" href="downloads.html"/>