diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml index 7d738e56..76861ae6 100644 --- a/.github/workflows/maven.yml +++ b/.github/workflows/maven.yml @@ -47,4 +47,4 @@ jobs: cache: 'maven' - name: Build with Maven - run: mvn clean verify -e -B -V -P run-its + run: mvn clean verify -e -B -V -P run-its site -Preporting diff --git a/mrm-api/src/main/java/org/codehaus/mojo/mrm/api/maven/ArchetypeCatalogNotFoundException.java b/mrm-api/src/main/java/org/codehaus/mojo/mrm/api/maven/ArchetypeCatalogNotFoundException.java index 3f6e7b9e..a1b47257 100644 --- a/mrm-api/src/main/java/org/codehaus/mojo/mrm/api/maven/ArchetypeCatalogNotFoundException.java +++ b/mrm-api/src/main/java/org/codehaus/mojo/mrm/api/maven/ArchetypeCatalogNotFoundException.java @@ -34,7 +34,6 @@ public class ArchetypeCatalogNotFoundException /** * Creates a new {@link ArchetypeCatalogNotFoundException}. * - * @param path the path of the metadata that was not found. * @since 1.0 */ public ArchetypeCatalogNotFoundException() @@ -46,7 +45,6 @@ public ArchetypeCatalogNotFoundException() * Creates a new {@link ArchetypeCatalogNotFoundException}. * * @param message The message. - * @param path the path of the metadata that was not found. * @since 1.0 */ public ArchetypeCatalogNotFoundException( String message ) @@ -58,7 +56,6 @@ public ArchetypeCatalogNotFoundException( String message ) * Creates a new {@link ArchetypeCatalogNotFoundException}. * * @param message The message. - * @param path the path of the metadata that was not found. * @param cause the reason why it was not found (or null if there is no specific reason) * @since 1.0 */ diff --git a/mrm-api/src/main/java/org/codehaus/mojo/mrm/api/maven/ArtifactStore.java b/mrm-api/src/main/java/org/codehaus/mojo/mrm/api/maven/ArtifactStore.java index d7e74cfa..5fa400c1 100644 --- a/mrm-api/src/main/java/org/codehaus/mojo/mrm/api/maven/ArtifactStore.java +++ b/mrm-api/src/main/java/org/codehaus/mojo/mrm/api/maven/ArtifactStore.java @@ -34,6 +34,7 @@ public interface ArtifactStore { /** + *

* Returns the set of groupIds that begin with the specified prefix. Some implementations may be lazy caching * implementations, in which case it is permitted to return either the empty set, or only those entries which * have been loaded into the cache, so consumers should not assume that a missing entry implies non-existence. @@ -45,6 +46,7 @@ public interface ArtifactStore * assertEquals(new HashSet<String>(Arrays.asList("org.codehaus", "org.apache")), getGroupIds("org")); // query with a prefix * assertEquals(new HashSet<String>(Arrays.asList("org.codehaus.mojo")), getGroupIds("org.codehaus")); * + *

* Note that while the existence of groupId org.codehaus.mojo implies that there must be groupIds * org and org.codehaus there is no requirement that an implementation should * report these inferred parent groupIds, it is just strongly encouraged. @@ -61,6 +63,7 @@ public interface ArtifactStore Set getGroupIds( String parentGroupId ); /** + *

* Returns the set of artifactIds that belong in the specified groupId. Some implementations may be lazy caching * implementations, in which case it is permitted to return either the empty set, or only those entries which * have been loaded into the cache, so consumers should not assume that a missing entry implies non-existence. @@ -77,6 +80,7 @@ public interface ArtifactStore Set getArtifactIds( String groupId ); /** + *

* Returns the set of versions of the specified groupId:artifactId. Some implementations may be lazy caching * implementations, in which case it is permitted to return either the empty set, or only those entries which * have been loaded into the cache, so consumers should not assume that a missing entry implies non-existence. @@ -200,7 +204,7 @@ long getMetadataLastModified( String path ) /** * - * @return + * @return ArchetypeCatalog * @throws IOException if an I/O error occurs. * @throws ArchetypeCatalogNotFoundException if the archetypeCatalog does not exist. * @since 1.0 @@ -209,7 +213,7 @@ long getMetadataLastModified( String path ) /** * - * @return + * @return long * @throws IOException if an I/O error occurs. * @throws ArchetypeCatalogNotFoundException if the archetypeCatalog does not exist. * @since 1.0 @@ -218,7 +222,7 @@ long getMetadataLastModified( String path ) /** * - * @param content + * @param content the content * @throws IOException if an I/O error occurs. * @since 1.0 */ diff --git a/mrm-api/src/main/javadoc/org/codehaus/mojo/mrm/api/maven/package.html b/mrm-api/src/main/javadoc/org/codehaus/mojo/mrm/api/maven/package.html deleted file mode 100644 index 35f07467..00000000 --- a/mrm-api/src/main/javadoc/org/codehaus/mojo/mrm/api/maven/package.html +++ /dev/null @@ -1,30 +0,0 @@ - - - - - - - - Maven-aware API - - -This Maven aware contract for a repository. The contract is defined by the {@link ArtifactStore} interface. -In general it is preferred to extend the Base or Default classes rather than implement the interfaces -directly, as this permits the addition of new methods to the interface without breaking existing code. -@since 1.0 - - \ No newline at end of file diff --git a/mrm-api/src/main/javadoc/org/codehaus/mojo/mrm/api/package.html b/mrm-api/src/main/javadoc/org/codehaus/mojo/mrm/api/package.html deleted file mode 100644 index 19c53d58..00000000 --- a/mrm-api/src/main/javadoc/org/codehaus/mojo/mrm/api/package.html +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - - - Core API - - -This is the core contract of a repository. The basic contract of a repository is defined in the {@link FileSystem} -contract. In general it is preferred to extend the Base or Default classes rather than implement the interfaces -directly, as this permits the addition of new methods to the interface without breaking existing code. - -@since 1.0 - - \ No newline at end of file diff --git a/mrm-api/src/main/javadoc/org/codehaus/mojo/mrm/plugin/package.html b/mrm-api/src/main/javadoc/org/codehaus/mojo/mrm/plugin/package.html deleted file mode 100644 index 0dfcd2a9..00000000 --- a/mrm-api/src/main/javadoc/org/codehaus/mojo/mrm/plugin/package.html +++ /dev/null @@ -1,30 +0,0 @@ - - - - - - - - Maven Plugin Extension API - - -This is the contract for the Maven Plugin Extensions that allow for plugging in custom repository types into -the Maven plugin. - -@since 1.0 - - \ No newline at end of file diff --git a/mrm-api/src/main/javadoc/overview.html b/mrm-api/src/main/javadoc/overview.html deleted file mode 100644 index a1b6c721..00000000 --- a/mrm-api/src/main/javadoc/overview.html +++ /dev/null @@ -1,39 +0,0 @@ - - - - - - - - Mock Repository Manager API Overview - - -The Mock Repository Manager API defines the contracts required in order to present a mock or lightweight repository -manager. -There are two sets of contract. -

- - \ No newline at end of file diff --git a/mrm-maven-plugin/src/main/java/org/codehaus/mojo/mrm/plugin/RunMojo.java b/mrm-maven-plugin/src/main/java/org/codehaus/mojo/mrm/plugin/RunMojo.java index d289848e..a8b97108 100644 --- a/mrm-maven-plugin/src/main/java/org/codehaus/mojo/mrm/plugin/RunMojo.java +++ b/mrm-maven-plugin/src/main/java/org/codehaus/mojo/mrm/plugin/RunMojo.java @@ -30,7 +30,8 @@ * settings.xml and still work behind a proxy. * * @author Stephen Connolly - * @description Starts a mock repository manager for manual testing. + * + * Starts a mock repository manager for manual testing. */ @Mojo( name = "run", requiresProject = false, requiresDirectInvocation = true, threadSafe = true ) public class RunMojo diff --git a/mrm-maven-plugin/src/main/java/org/codehaus/mojo/mrm/plugin/StartMojo.java b/mrm-maven-plugin/src/main/java/org/codehaus/mojo/mrm/plugin/StartMojo.java index 6ae0a91b..f708adaf 100644 --- a/mrm-maven-plugin/src/main/java/org/codehaus/mojo/mrm/plugin/StartMojo.java +++ b/mrm-maven-plugin/src/main/java/org/codehaus/mojo/mrm/plugin/StartMojo.java @@ -31,7 +31,8 @@ * settings.xml and still work behind a proxy. * * @author Stephen Connolly - * @description Starts a mock repository manager as part of a maven build for use by integration tests. + * + * Starts a mock repository manager as part of a maven build for use by integration tests. */ @Mojo( name = "start", defaultPhase = LifecyclePhase.PRE_INTEGRATION_TEST, requiresProject = false, threadSafe = true ) public class StartMojo diff --git a/mrm-maven-plugin/src/main/java/org/codehaus/mojo/mrm/plugin/StopMojo.java b/mrm-maven-plugin/src/main/java/org/codehaus/mojo/mrm/plugin/StopMojo.java index d5a5e7cb..74510b28 100644 --- a/mrm-maven-plugin/src/main/java/org/codehaus/mojo/mrm/plugin/StopMojo.java +++ b/mrm-maven-plugin/src/main/java/org/codehaus/mojo/mrm/plugin/StopMojo.java @@ -28,7 +28,8 @@ * settings.xml and still work behind a proxy. * * @author Stephen Connolly - * @description Stops the mock repository manager started by mrm:start as part of a maven build for use + * + * Stops the mock repository manager started by mrm:start as part of a maven build for use * by integration tests. */ @Mojo( name = "stop", defaultPhase = LifecyclePhase.POST_INTEGRATION_TEST, requiresProject = false, threadSafe = true ) diff --git a/mrm-servlet/src/main/javadoc/org/codehaus/mojo/mrm/impl/digest/package.html b/mrm-servlet/src/main/javadoc/org/codehaus/mojo/mrm/impl/digest/package.html deleted file mode 100644 index 4767d478..00000000 --- a/mrm-servlet/src/main/javadoc/org/codehaus/mojo/mrm/impl/digest/package.html +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - - Digest generating filesystem overlays - - -This package provides a filesystem overlay that will generate missing digests for entries. - -@since 1.0 - - \ No newline at end of file diff --git a/mrm-servlet/src/main/javadoc/org/codehaus/mojo/mrm/impl/maven/package.html b/mrm-servlet/src/main/javadoc/org/codehaus/mojo/mrm/impl/maven/package.html deleted file mode 100644 index 4c141244..00000000 --- a/mrm-servlet/src/main/javadoc/org/codehaus/mojo/mrm/impl/maven/package.html +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - - Maven Implementations - - -This package contains implementations of the {@link org.codehaus.mojo.mrm.maven} contracts. - -@since 1.0 - - \ No newline at end of file diff --git a/mrm-servlet/src/main/javadoc/org/codehaus/mojo/mrm/impl/package.html b/mrm-servlet/src/main/javadoc/org/codehaus/mojo/mrm/impl/package.html deleted file mode 100644 index 70a7af50..00000000 --- a/mrm-servlet/src/main/javadoc/org/codehaus/mojo/mrm/impl/package.html +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - - Core Implementations - - -This package contains implementations of the {@link org.codehaus.mojo.mrm} contracts. - -@since 1.0 - - \ No newline at end of file diff --git a/mrm-servlet/src/main/javadoc/org/codehaus/mojo/mrm/plugin/package.html b/mrm-servlet/src/main/javadoc/org/codehaus/mojo/mrm/plugin/package.html deleted file mode 100644 index 58347bfd..00000000 --- a/mrm-servlet/src/main/javadoc/org/codehaus/mojo/mrm/plugin/package.html +++ /dev/null @@ -1,30 +0,0 @@ - - - - - - - - Maven Plugin Extension Implementations - - -This package contains the {@link FileSystemFactory} and {@link ArtifactStoreFactory} implementations for injection -by Plexus into the Maven Plugin. - -@since 1.0 - - \ No newline at end of file diff --git a/mrm-servlet/src/main/javadoc/org/codehaus/mojo/mrm/servlet/package.html b/mrm-servlet/src/main/javadoc/org/codehaus/mojo/mrm/servlet/package.html deleted file mode 100644 index 71603067..00000000 --- a/mrm-servlet/src/main/javadoc/org/codehaus/mojo/mrm/servlet/package.html +++ /dev/null @@ -1,29 +0,0 @@ - - - - - - - - Servlet Implementation - - -This package contains a servlet that will serve a {@link FileSystem} over HTTP/HTTPS. - -@since 1.0 - - \ No newline at end of file diff --git a/mrm-servlet/src/main/javadoc/overview.html b/mrm-servlet/src/main/javadoc/overview.html deleted file mode 100644 index 4fbfff87..00000000 --- a/mrm-servlet/src/main/javadoc/overview.html +++ /dev/null @@ -1,27 +0,0 @@ - - - - - - - - Mock Repository Manager Implementation Overview - - -The implementation of the Mock Repository Manager API. - - \ No newline at end of file