Skip to content

Commit

Permalink
fix site generation, remove useless javadoc
Browse files Browse the repository at this point in the history
Signed-off-by: Olivier Lamy <olamy@apache.org>
  • Loading branch information
olamy committed Nov 28, 2021
1 parent c46bf49 commit e176401
Show file tree
Hide file tree
Showing 16 changed files with 14 additions and 313 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/maven.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand All @@ -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 )
Expand All @@ -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 <code>null</code> if there is no specific reason)
* @since 1.0
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ public interface ArtifactStore
{

/**
* <p>
* 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.
Expand All @@ -45,6 +46,7 @@ public interface ArtifactStore
* assertEquals(new HashSet&lt;String>(Arrays.asList("org.codehaus", "org.apache")), getGroupIds("org")); // query with a prefix
* assertEquals(new HashSet&lt;String>(Arrays.asList("org.codehaus.mojo")), getGroupIds("org.codehaus"));
* </pre>
* <p>
* Note that while the existence of groupId <code>org.codehaus.mojo</code> implies that there must be groupIds
* <code>org</code> and <code>org.codehaus</code> there is no requirement that an implementation should
* report these inferred parent groupIds, it is just strongly encouraged.
Expand All @@ -61,6 +63,7 @@ public interface ArtifactStore
Set<String> getGroupIds( String parentGroupId );

/**
* <p>
* 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.
Expand All @@ -77,6 +80,7 @@ public interface ArtifactStore
Set<String> getArtifactIds( String groupId );

/**
* <p>
* 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.
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
*/
Expand Down

This file was deleted.

31 changes: 0 additions & 31 deletions mrm-api/src/main/javadoc/org/codehaus/mojo/mrm/api/package.html

This file was deleted.

30 changes: 0 additions & 30 deletions mrm-api/src/main/javadoc/org/codehaus/mojo/mrm/plugin/package.html

This file was deleted.

39 changes: 0 additions & 39 deletions mrm-api/src/main/javadoc/overview.html

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@
* <code>settings.xml</code> 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@
* <code>settings.xml</code> 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@
* <code>settings.xml</code> and still work behind a proxy.
*
* @author Stephen Connolly
* @description Stops the mock repository manager started by <code>mrm:start</code> as part of a maven build for use
*
* Stops the mock repository manager started by <code>mrm:start</code> as part of a maven build for use
* by integration tests.
*/
@Mojo( name = "stop", defaultPhase = LifecyclePhase.POST_INTEGRATION_TEST, requiresProject = false, threadSafe = true )
Expand Down

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Loading

0 comments on commit e176401

Please sign in to comment.