Add more detailed Javadocs

stelfrich · stelfrich · commit e89cc12be2c9 · 2018-08-10T07:15:34.000+02:00
diff --git a/src/main/java/org/scijava/maven/plugin/install/CopyJarsMojo.java b/src/main/java/org/scijava/maven/plugin/install/CopyJarsMojo.java
@@ -57,6 +57,14 @@
  * Copies .jar artifacts and their dependencies into a SciJava application
  * directory structure.
  * 
+ * ImageJ 1.x plugins (identified by containing a plugins.config file) get
+ * copied to the plugins/ subdirectory and all other .jar files to jars/.
+ * However, you can override this decision by setting the scijava.app.subdirectory
+ * property to a specific subdirectory. It expects the location of the SciJava
+ * application directory to be specified in the scijava.app.directory property
+ * (which can be set on the Maven command-line). If said property is not set,
+ * the copy-jars goal is skipped.
+ * 
  * @author Johannes Schindelin
  * @author Stefan Helfrich
  */
diff --git a/src/main/java/org/scijava/maven/plugin/install/InstallArtifactMojo.java b/src/main/java/org/scijava/maven/plugin/install/InstallArtifactMojo.java
@@ -72,10 +72,19 @@
 import org.codehaus.plexus.util.StringUtils;
 
 /**
- * Downloads .jar artifacts and their dependencies into an ImageJ.app/ directory
- * structure.
+ * Downloads .jar artifacts and their dependencies into a SciJava application
+ * directory structure.
+ * 
+ * ImageJ 1.x plugins (identified by containing a plugins.config file) get
+ * copied to the plugins/ subdirectory and all other .jar files to jars/.
+ * However, you can override this decision by setting the scijava.app.subdirectory
+ * property to a specific subdirectory. It expects the location of the SciJava
+ * application directory to be specified in the scijava.app.directory property
+ * (which can be set on the Maven command-line). If said property is not set,
+ * the install-artifact goal is skipped.
  * 
  * @author Johannes Schindelin
+ * @author Stefan Helfrich
  */
 @Mojo(name = "install-artifact", requiresProject=false)
 public class InstallArtifactMojo extends AbstractCopyJarsMojo {
