From 766847585e001561b73dccabb46e9e164d4f87f4 Mon Sep 17 00:00:00 2001 From: Jose Luis Osorno Date: Mon, 28 Jan 2019 12:30:05 +0100 Subject: [PATCH] Fix javadoc errors - Fix the javadoc error raised by the javadoc-maven-plugin. - Configure the javadoc-maven-plugin to accept custom javadoc annotations from maven mojo development. --- .../org/alfresco/rad/SpringContextHolder.java | 2 +- .../alfresco/rad/test/AlfrescoTestRunner.java | 16 +++--- .../java/org/alfresco/rad/test/Remote.java | 5 +- .../alfresco/rad/test/RunTestWebScript.java | 5 +- .../plugin/AbstractRefreshWebappMojo.java | 4 ++ .../maven/plugin/AbstractRunMojo.java | 49 +++++++++++------ .../alfresco/maven/plugin/InstallMojo.java | 3 +- .../maven/plugin/IntegrationTestMojo.java | 5 +- .../alfresco/maven/plugin/RefreshMojo.java | 3 +- .../maven/plugin/RefreshRepoWebappMojo.java | 3 +- .../maven/plugin/RefreshShareWebappMojo.java | 3 +- .../alfresco/maven/plugin/VersionMojo.java | 5 +- .../maven/plugin/archiver/AmpUnArchiver.java | 2 +- .../maven/plugin/config/ModuleDependency.java | 9 ++-- .../maven/plugin/config/TomcatDependency.java | 3 +- .../maven/plugin/config/TomcatWebapp.java | 3 +- pom.xml | 53 +++++++++++++++++++ 17 files changed, 129 insertions(+), 44 deletions(-) diff --git a/modules/alfresco-rad/src/main/java/org/alfresco/rad/SpringContextHolder.java b/modules/alfresco-rad/src/main/java/org/alfresco/rad/SpringContextHolder.java index 437f345f..17f5cb83 100644 --- a/modules/alfresco-rad/src/main/java/org/alfresco/rad/SpringContextHolder.java +++ b/modules/alfresco-rad/src/main/java/org/alfresco/rad/SpringContextHolder.java @@ -51,7 +51,7 @@ public class SpringContextHolder implements ApplicationContextAware { /** * Return the singleton instance * - * @return + * @return the singleton instance */ public static SpringContextHolder Instance() { return springContextHolderInstance; diff --git a/modules/alfresco-rad/src/main/java/org/alfresco/rad/test/AlfrescoTestRunner.java b/modules/alfresco-rad/src/main/java/org/alfresco/rad/test/AlfrescoTestRunner.java index c94ea514..7a2dae02 100644 --- a/modules/alfresco-rad/src/main/java/org/alfresco/rad/test/AlfrescoTestRunner.java +++ b/modules/alfresco-rad/src/main/java/org/alfresco/rad/test/AlfrescoTestRunner.java @@ -46,6 +46,7 @@ import javax.xml.parsers.ParserConfigurationException; import java.io.*; /** + *

* This is a JUnit test runner that is designed to work with an Alfresco repository. * It detects if it's executing a test inside of a running Alfresco instance. If that * is the case the tests are all run normally. If however the test is being run from @@ -54,14 +55,15 @@ import java.io.*; * test an HTTP request is made to a Web Script in a running Alfresco instance. This * Web Script runs the test and returns enough information to this class so we can * emulate having run the test locally. - *

+ *

+ *

* By doing this, we are able to create Integration Tests (IT) using standard JUnit * capabilities. These can then be run from our IDEs with the associated visualizations, * support for re-running failed tests, etc. - *

+ *

* Integration testing framework donated by Zia Consulting * - * @author Bindu Wavell + * @author Bindu Wavell (bindu@ziaconsulting.com) * @author martin.bergljung@alfresco.com (some editing) * @since 3.0 */ @@ -104,8 +106,8 @@ public class AlfrescoTestRunner extends BlockJUnit4ClassRunner { * Call a remote Alfresco server and have the test run there. * * @param method the test method to run - * @param notifier - * @param desc + * @param notifier given @{@link RunNotifier} to notify the result of the test + * @param desc given @{@link Description} of the test to run */ protected void callProxiedChild(FrameworkMethod method, RunNotifier notifier, Description desc) { notifier.fireTestStarted(desc); @@ -232,8 +234,8 @@ public class AlfrescoTestRunner extends BlockJUnit4ClassRunner { * Check the @Remote config on the test class to see where the * Alfresco Repo is running * - * @param method - * @return + * @param method given @{@link FrameworkMethod} to be executed + * @return the ACS endpoint */ protected String getContextRoot(FrameworkMethod method) { Class declaringClass = method.getMethod().getDeclaringClass(); diff --git a/modules/alfresco-rad/src/main/java/org/alfresco/rad/test/Remote.java b/modules/alfresco-rad/src/main/java/org/alfresco/rad/test/Remote.java index 0a1cfd3e..b99ce9b2 100644 --- a/modules/alfresco-rad/src/main/java/org/alfresco/rad/test/Remote.java +++ b/modules/alfresco-rad/src/main/java/org/alfresco/rad/test/Remote.java @@ -24,14 +24,15 @@ import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** + *

* By default the ${@link AlfrescoTestRunner} will attempt to find a * running Alfresco instance at http://localhost:8080/alfresco * This annotation can be applied to a test class to have the * proxy calls go to a different host/port. - *

+ *

* Integration testing framework donated by Zia Consulting. * - * @author Bindu Wavell + * @author Bindu Wavell (bindu@ziaconsulting.com) * @since 3.0 */ @Target(ElementType.TYPE) diff --git a/modules/alfresco-rad/src/main/java/org/alfresco/rad/test/RunTestWebScript.java b/modules/alfresco-rad/src/main/java/org/alfresco/rad/test/RunTestWebScript.java index bd060a6f..72877ac9 100644 --- a/modules/alfresco-rad/src/main/java/org/alfresco/rad/test/RunTestWebScript.java +++ b/modules/alfresco-rad/src/main/java/org/alfresco/rad/test/RunTestWebScript.java @@ -35,14 +35,15 @@ import java.util.List; import java.util.Map; /** + *

* This Web Script works in consort with the ${@link AlfrescoTestRunner}. When a test is run from an IDE or * command line, the Alfresco test runner sends a proxied request to perform the test to this script. This runs * the test and wraps the results up so that the test initiator can be fooled into thinking they are * running the tests locally. - *

+ *

* Integration testing framework donated by Zia Consulting. * - * @author Bindu Wavell + * @author Bindu Wavell (bindu@ziaconsulting.com) * @author martin.bergljung@alfresco.com (some editing) * @since 3.0 */ diff --git a/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/AbstractRefreshWebappMojo.java b/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/AbstractRefreshWebappMojo.java index bb236ef1..013c5f73 100644 --- a/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/AbstractRefreshWebappMojo.java +++ b/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/AbstractRefreshWebappMojo.java @@ -164,6 +164,8 @@ public abstract class AbstractRefreshWebappMojo extends AbstractMojo { /** * Perform a Refresh of Web Scripts container in webapp. * Called by specific refresh mojo implementation. + * + * @param url the relative path to refresh webscripts */ protected void refreshWebScripts(String url) { // Create the Refresh URL for the Alfresco Tomcat server @@ -184,6 +186,8 @@ public abstract class AbstractRefreshWebappMojo extends AbstractMojo { /** * Perform a Clear Dependency Caches call on Share webapp. * Called by specific refresh mojo implementation, currently only applicable to Share webapp. + * + * @param url the relative path to clear cache */ protected void clearDependencyCaches(String url) { // Create the Clear Cache URL for the Alfresco Tomcat server diff --git a/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/AbstractRunMojo.java b/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/AbstractRunMojo.java index 66d41fbf..d4a4a842 100644 --- a/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/AbstractRunMojo.java +++ b/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/AbstractRunMojo.java @@ -427,6 +427,8 @@ public abstract class AbstractRunMojo extends AbstractMojo { /** * Get the Tomcat port. By default the port is changed by using the maven.alfresco.tomcat.port property * but for legacy and external configuration purposes maven.tomcat.port will override if defined + * + * @return the Tomcat port */ protected String getPort() { String port = tomcatPort; @@ -439,7 +441,9 @@ public abstract class AbstractRunMojo extends AbstractMojo { } /** + * Check if Tomcat is already running. * + * @return true if Tomcat is already running, false otherwise */ protected boolean tomcatIsRunning() { @@ -464,7 +468,7 @@ public abstract class AbstractRunMojo extends AbstractMojo { * Download and unpack the Solr 4 configuration as we don't have it in the project. * It will reside under /alf_data_dev/solr * - * @throws MojoExecutionException + * @throws MojoExecutionException when any problem appears unpacking the Solr configuration */ protected void unpackSolrConfig() throws MojoExecutionException { getLog().info("Unpacking Solr config"); @@ -497,7 +501,7 @@ public abstract class AbstractRunMojo extends AbstractMojo { * For windows paths, convert single \ to / for the ${alfresco.solr.data.dir} path, * by default it will be c:\bla\, we need forward slash or double backslash. * - * @throws MojoExecutionException + * @throws MojoExecutionException when any problem appears fixing the Solr home path */ protected void fixSolrHomePath() throws MojoExecutionException { getLog().info("Fix Solr Home Path to work in Windows"); @@ -524,7 +528,7 @@ public abstract class AbstractRunMojo extends AbstractMojo { * Copy custom solr configuration files over, so a * developer can overwrite any files needed * - * @throws MojoExecutionException + * @throws MojoExecutionException when any problem appears copying the Solr custom configuration */ protected void copySolrCustomConfig() throws MojoExecutionException { getLog().info("Copying custom Solr config"); @@ -553,7 +557,7 @@ public abstract class AbstractRunMojo extends AbstractMojo { * Replace property placeholders in configuration files for the cores, so the * index files can be found for each core when Solr starts up. * - * @throws MojoExecutionException + * @throws MojoExecutionException when any problem appears replacing the Solr configuration properties */ protected void replaceSolrConfigProperties() throws MojoExecutionException { getLog().info("Replacing Solr config properties"); @@ -601,7 +605,7 @@ public abstract class AbstractRunMojo extends AbstractMojo { * If we are in Alfresco version 4.2 or younger the Solr 1.0 WAR is not available as Maven artifact, just * as part of a ZIP file, so install it locally so we can deploy from embedded tomcat * - * @throws MojoExecutionException + * @throws MojoExecutionException when any problem appears installing Solr10 in the local repository */ protected void installSolr10InLocalRepo() throws MojoExecutionException { if (isPlatformVersionLtOrEqTo42()) { @@ -715,12 +719,13 @@ public abstract class AbstractRunMojo extends AbstractMojo { } /** + *

* Replaces web.xml where applicable in platform webapp (alfresco.war), * commenting out the security-constraints. - *

+ *

* This is only needed for 4.2, 5.0 (5.1 handles it automatically when turning off ssl via props) * - * @throws MojoExecutionException + * @throws MojoExecutionException when any problem appears commenting out the security configuration */ protected void commentOutSecureCommsInPlatformWebXml() throws MojoExecutionException { if (isPlatformVersionGtOrEqTo51()) { @@ -764,7 +769,7 @@ public abstract class AbstractRunMojo extends AbstractMojo { * enterprise db config) that will be used when running Alfresco. It contains database connection parameters and * other general configuration for Alfresco Repository (alfresco.war) * - * @throws MojoExecutionException + * @throws MojoExecutionException when any problem appears copying the Alfresco global properties file */ protected void copyAlfrescoGlobalProperties() throws MojoExecutionException { getLog().info("Copying and filtering alfresco-global-*.properties files to target/test-classes"); @@ -856,7 +861,7 @@ public abstract class AbstractRunMojo extends AbstractMojo { * Rename the configured database specific alfresco-global-*.properties file to * alfresco-global.properties so it will be used during Tomcat run. * - * @throws MojoExecutionException + * @throws MojoExecutionException when any problem appears renaming the alfresco global properties */ protected void renameAlfrescoGlobalProperties() throws MojoExecutionException { String alfrescoGlobalFilePath = project.getBuild().getTestOutputDirectory() + "/alfresco-global-"; @@ -904,7 +909,7 @@ public abstract class AbstractRunMojo extends AbstractMojo { * Copy the Alfresco Enterprise license to its correct place in the Platform WAR, if it exists. * It is not enough to have it on the test classpath, then it will start up as Trial license... * - * @throws MojoExecutionException + * @throws MojoExecutionException when any problem appears copying the Alfresco license */ protected void copyAlfrescoLicense() throws MojoExecutionException { if (alfrescoEdition.equals(ALFRESCO_COMMUNITY_EDITION)) { @@ -943,7 +948,7 @@ public abstract class AbstractRunMojo extends AbstractMojo { /** * Copy the Activiti Log4J Dev config into the activitiApp-war/WEB-INF/classes dir. * - * @throws MojoExecutionException + * @throws MojoExecutionException when any problem appears copying the activity Log4J dev configuration */ protected void copyActivitiLog4JDevConfig() throws MojoExecutionException { final String warOutputDir = getWarOutputDir(ACTIVITI_APP_WAR_PREFIX_NAME); @@ -978,7 +983,7 @@ public abstract class AbstractRunMojo extends AbstractMojo { /** * Copy Share Config Custom in order to have global overrides for development and dynamic port * - * @throws MojoExecutionException + * @throws MojoExecutionException when any problem appears copying share config custom file */ protected void copyShareConfigCustom() throws MojoExecutionException { final String warOutputDir = getWarOutputDir(SHARE_WAR_PREFIX_NAME); @@ -1019,7 +1024,7 @@ public abstract class AbstractRunMojo extends AbstractMojo { * There is no custom classpath resolve mechanism for Share log4j, * to log custom stuff overriding standard log4j.properties is needed. * - * @throws MojoExecutionException + * @throws MojoExecutionException when any problem appears copying the share log4j configuration */ protected void copyShareLog4jConfig() throws MojoExecutionException { if (!useCustomShareLog4jConfig) { @@ -1059,7 +1064,9 @@ public abstract class AbstractRunMojo extends AbstractMojo { /** * Copy and Build hotswap-agent.properties * - * @throws MojoExecutionException + * @param warPrefix path to the war root directory + * + * @throws MojoExecutionException when any problem appears copying hotswap agent properties */ protected void copyHotswapAgentProperties(String warPrefix) throws MojoExecutionException { if ( copyHotswapAgentConfig == false ) { @@ -1093,6 +1100,8 @@ public abstract class AbstractRunMojo extends AbstractMojo { * Build the customized Platform webapp (i.e. the Repository, alfresco.war) * that should be deployed by Tomcat by applying all AMPs and JARs from * the {@code } configuration. + * + * @throws MojoExecutionException when any problem appears building the platform war */ protected void buildPlatformWar() throws MojoExecutionException { buildCustomWarInDir(PLATFORM_WAR_PREFIX_NAME, platformModules, @@ -1114,6 +1123,8 @@ public abstract class AbstractRunMojo extends AbstractMojo { * Build the customized Share webapp (i.e. the share.war) * that should be deployed by Tomcat by applying all AMPs and JARs from * the {@code } configuration. + * + * @throws MojoExecutionException when any problem appears building the share war */ protected void buildShareWar() throws MojoExecutionException { buildCustomWarInDir(SHARE_WAR_PREFIX_NAME, shareModules, @@ -1136,6 +1147,8 @@ public abstract class AbstractRunMojo extends AbstractMojo { * Build the customized Activiti App webapp (i.e. the activiti-app.war) * that should be deployed by Tomcat by applying all JARs from * the {@code } configuration. + * + * @throws MojoExecutionException when any problem appears building the activity war */ protected void buildActivitiAppWar() throws MojoExecutionException { buildCustomWarInDir(ACTIVITI_APP_WAR_PREFIX_NAME, activitiModules, @@ -1160,7 +1173,7 @@ public abstract class AbstractRunMojo extends AbstractMojo { * @param originalWarGroupId the Maven groupId for the original war file that should be customized * @param originalWarArtifactId the Maven artifactId for the original war file that should be customized * @param originalWarVersion the Maven version for the original war file that should be customized - * @throws MojoExecutionException + * @throws MojoExecutionException when any problem appears building the custom war */ protected void buildCustomWarInDir(String warName, List modules, @@ -1283,7 +1296,7 @@ public abstract class AbstractRunMojo extends AbstractMojo { * * @param warName the name of the custom war * @return the customized war file artifactId, to be used by the tomcat7 plugin - * @throws MojoExecutionException + * @throws MojoExecutionException when any problem appears packaging or installing the custom war */ protected String packageAndInstallCustomWar(String warName) throws MojoExecutionException { final String warArtifactId = "${project.artifactId}-" + warName; @@ -1318,6 +1331,8 @@ public abstract class AbstractRunMojo extends AbstractMojo { /** * Check that a database configuration has been supplied correctly + * + * @throws MojoExecutionException when any problem appears checking the database configuration */ protected void checkDatabaseConfig() throws MojoExecutionException { // Only do this check if we are running alfresco.war or activiti-app.war that needs a database. @@ -1348,7 +1363,7 @@ public abstract class AbstractRunMojo extends AbstractMojo { * configured in the SDK project. * * @param fork true if tomcat process should be forked - * @throws MojoExecutionException + * @throws MojoExecutionException when any problem appears starting tomcat */ protected void startTomcat(boolean fork) throws MojoExecutionException { getLog().info("Starting Tomcat, fork = " + fork); diff --git a/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/InstallMojo.java b/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/InstallMojo.java index b53e25a4..4ca97688 100644 --- a/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/InstallMojo.java +++ b/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/InstallMojo.java @@ -26,9 +26,10 @@ import org.apache.maven.plugin.MojoExecutionException; import org.apache.maven.plugin.MojoFailureException; /** + *

* Performs a AMP to WAR overlay invoking the Alfresco Repository ModuleManagementTool. * It therefore wraps and emulates the same WAR overlay performed by Alfresco MMT. - *

+ *

* This goal will install the AMP file(s) found in ${ampLocation} onto the WAR (or exploded WAR) found in ${warLocation} * * @version $Id:$ diff --git a/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/IntegrationTestMojo.java b/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/IntegrationTestMojo.java index 6c36f76e..b2dbc520 100644 --- a/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/IntegrationTestMojo.java +++ b/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/IntegrationTestMojo.java @@ -35,12 +35,13 @@ import java.util.Properties; import static org.twdata.maven.mojoexecutor.MojoExecutor.*; /** + *

* Alfresco Plugin mojo that are used when you want to run Integration Tests. * It will package up all the Integration Test classes and execute contained * tests with the Maven Failsafe plugin. The test classes will be added * to the platform war so they can be executed remotely via - * the ${@link org.alfresco.rad.test.AlfrescoTestRunner} - *

+ * the AlfrescoTestRunner. + *

* The Alfresco RAD module is also added to the Platform WAR so * the Alfresco Test runner classes are available. * diff --git a/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/RefreshMojo.java b/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/RefreshMojo.java index 26427eb0..b0ff0ea8 100644 --- a/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/RefreshMojo.java +++ b/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/RefreshMojo.java @@ -21,11 +21,12 @@ import org.apache.maven.plugins.annotations.LifecyclePhase; import org.apache.maven.plugins.annotations.Mojo; /** + *

* Refresh Alfresco Repo and Share Mojo. * Will refresh the Web Script container so new and changed * Spring Surf Web Scripts are detected. * Will also clear the dependency caches for web resources (CSS, JS, etc). - *

+ *

* It is important to execute the refresh calls in the compile phase, * otherwise the files will be copied after this and the refresh calls * will not be recognized. diff --git a/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/RefreshRepoWebappMojo.java b/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/RefreshRepoWebappMojo.java index c741c90a..9e38ab9b 100644 --- a/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/RefreshRepoWebappMojo.java +++ b/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/RefreshRepoWebappMojo.java @@ -21,10 +21,11 @@ import org.apache.maven.plugins.annotations.LifecyclePhase; import org.apache.maven.plugins.annotations.Mojo; /** + *

* Refresh Alfresco Repository (alfresco.war) Mojo. * Will refresh the Web Script container so new and changed * Web Scripts are detected. - *

+ *

* It is important to execute the refresh calls in the compile phase, * otherwise the files will be copied after this and the refresh calls * will not be recognized. diff --git a/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/RefreshShareWebappMojo.java b/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/RefreshShareWebappMojo.java index 157e1898..30b40567 100644 --- a/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/RefreshShareWebappMojo.java +++ b/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/RefreshShareWebappMojo.java @@ -21,11 +21,12 @@ import org.apache.maven.plugins.annotations.LifecyclePhase; import org.apache.maven.plugins.annotations.Mojo; /** + *

* Refresh Alfresco Share (share.war) Mojo. * Will refresh the Web Script container so new and changed * Spring Surf Web Scripts are detected. * Will also clear the dependency caches for web resources (CSS, JS, etc). - *

+ *

* It is important to execute the refresh calls in the compile phase, * otherwise the files will be copied after this and the refresh calls * will not be recognized. diff --git a/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/VersionMojo.java b/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/VersionMojo.java index 234d57fa..41d363c9 100644 --- a/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/VersionMojo.java +++ b/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/VersionMojo.java @@ -28,8 +28,7 @@ import org.apache.maven.project.MavenProject; /** * Removes -SNAPSHOT suffix from the version number (if present), optionally replacing it with a timestamp. - * The result is provided in the Maven property ${noSnapshotVersion} (name can be changed using - * myCustomVersion). + * The result is provided in the Maven property ${noSnapshotVersion}. * This feature is mostly needed to avoid Alfresco failing when installing AMP modules with non-numeric * versions. * @@ -67,7 +66,7 @@ public class VersionMojo extends AbstractMojo { /** * Allows to append a custom (numeric) value to the current artifact's version, * i.e. appending the SCM build number can be accomplished defining - * ${buildnumber} in the plugin + * <customVersionSuffix>${buildnumber}</customVersionSuffix> in the plugin * configuration. * * @parameter property="maven.alfresco.customVersionSuffix" diff --git a/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/archiver/AmpUnArchiver.java b/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/archiver/AmpUnArchiver.java index 58cdd1ec..8be254a3 100644 --- a/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/archiver/AmpUnArchiver.java +++ b/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/archiver/AmpUnArchiver.java @@ -14,7 +14,7 @@ import org.codehaus.plexus.component.annotations.Requirement; import org.codehaus.plexus.util.xml.Xpp3Dom; /** * This class provides AMP unpacking support for projects depending on AMPs - * This allows for example AMPs to be specified as in the maven-war-plugin + * This allows for example AMPs to be specified as <overlay> in the maven-war-plugin * @author mindthegab * */ diff --git a/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/config/ModuleDependency.java b/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/config/ModuleDependency.java index 7e2690e8..5d5d3f04 100644 --- a/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/config/ModuleDependency.java +++ b/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/config/ModuleDependency.java @@ -21,15 +21,18 @@ package org.alfresco.maven.plugin.config; import org.apache.commons.lang.StringUtils; /** + *

* Defines an Alfresco extension module dependency (JAR or AMP) to be * overlayed on an Alfresco webapp file. - *

+ *

+ *

* This is so we can skip the WAR projects in the AIO project, * and so we can include the Share Services AMP when running * with a simple platform JAR. - *

+ *

+ *

* This class is used by the RunMojo class. - *

+ *

* Alfresco Maven Plugin config looks something like this: * 
  *    {@code
diff --git a/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/config/TomcatDependency.java b/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/config/TomcatDependency.java
index 7fcb5122..05c64429 100644
--- a/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/config/TomcatDependency.java
+++ b/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/config/TomcatDependency.java
@@ -19,8 +19,9 @@
 package org.alfresco.maven.plugin.config;
 
 /**
+ * 

  * Tomcat Dependency used in Embedded Tomcat Maven plugin configuration.
- * 

+ * 

  * Alfresco Maven Plugin config looks something like this:
  * 
  *    {@code
diff --git a/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/config/TomcatWebapp.java b/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/config/TomcatWebapp.java
index f4793300..f489bb9e 100644
--- a/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/config/TomcatWebapp.java
+++ b/plugins/alfresco-maven-plugin/src/main/java/org/alfresco/maven/plugin/config/TomcatWebapp.java
@@ -18,11 +18,12 @@
 package org.alfresco.maven.plugin.config;
 
 /**
+ * 

  * Tomcat Webapp used in Embedded Tomcat Maven plugin configuration.
  * These are custom webapps that you would want to include for some reason
  * (The {webapp artifact}.war need to be available in a Maven Repo).
  * Note. the standard webapps are included with plugin properties such as enablePlatform and enableShare.
- * 

+ * 

  * Alfresco Maven Plugin config looks something like this:
  * 
  *    {@code
diff --git a/pom.xml b/pom.xml
index c3a8f397..e4a2af28 100644
--- a/pom.xml
+++ b/pom.xml
@@ -152,6 +152,59 @@
                         ${skipTests}
                     
                 
+                
+                    org.apache.maven.plugins
+                    maven-javadoc-plugin
+                    
+                        
+                            
+                                goal
+                                a
+                                Goal:
+                            
+                            
+                                requiresDependencyResolution
+                                a
+                                Requires Dependency Resolution:
+                            
+                            
+                                description
+                                a
+                                Description:
+                            
+                            
+                                phase
+                                a
+                                Phase:
+                            
+                            
+                                requiresProject
+                                a
+                                Requires Project:
+                            
+                            
+                                threadSafe
+                                a
+                                Thread-Safe:
+                            
+                            
+                                required
+                                a
+                                Required:
+                            
+                            
+                                readonly
+                                a
+                                Read only:
+                            
+                            
+                                parameter
+                                a
+                                Parameter:
+                            
+                        
+                    
+