Skip to content

Commit e176401

Browse files
olamyolamy
committed
fix site generation, remove useless javadoc
Signed-off-by: Olivier Lamy <[email protected]>
1 parent c46bf49 commit e176401

16 files changed

Lines changed: 14 additions & 313 deletions

File tree

‎.github/workflows/maven.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,4 @@ jobs:
4747
cache: 'maven'
4848

4949
- name: Build with Maven
50-
run: mvn clean verify -e -B -V -P run-its
50+
run: mvn clean verify -e -B -V -P run-its site -Preporting

‎mrm-api/src/main/java/org/codehaus/mojo/mrm/api/maven/ArchetypeCatalogNotFoundException.java‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@ public class ArchetypeCatalogNotFoundException
3434
/**
3535
* Creates a new {@link ArchetypeCatalogNotFoundException}.
3636
*
37-
* @param path the path of the metadata that was not found.
3837
* @since 1.0
3938
*/
4039
public ArchetypeCatalogNotFoundException()
@@ -46,7 +45,6 @@ public ArchetypeCatalogNotFoundException()
4645
* Creates a new {@link ArchetypeCatalogNotFoundException}.
4746
*
4847
* @param message The message.
49-
* @param path the path of the metadata that was not found.
5048
* @since 1.0
5149
*/
5250
public ArchetypeCatalogNotFoundException( String message )
@@ -58,7 +56,6 @@ public ArchetypeCatalogNotFoundException( String message )
5856
* Creates a new {@link ArchetypeCatalogNotFoundException}.
5957
*
6058
* @param message The message.
61-
* @param path the path of the metadata that was not found.
6259
* @param cause the reason why it was not found (or <code>null</code> if there is no specific reason)
6360
* @since 1.0
6461
*/

‎mrm-api/src/main/java/org/codehaus/mojo/mrm/api/maven/ArtifactStore.java‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ public interface ArtifactStore
3434
{
3535

3636
/**
37+
* <p>
3738
* Returns the set of groupIds that begin with the specified prefix. Some implementations may be lazy caching
3839
* implementations, in which case it is permitted to return either the empty set, or only those entries which
3940
* 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
4546
* assertEquals(new HashSet&lt;String>(Arrays.asList("org.codehaus", "org.apache")), getGroupIds("org")); // query with a prefix
4647
* assertEquals(new HashSet&lt;String>(Arrays.asList("org.codehaus.mojo")), getGroupIds("org.codehaus"));
4748
* </pre>
49+
* <p>
4850
* Note that while the existence of groupId <code>org.codehaus.mojo</code> implies that there must be groupIds
4951
* <code>org</code> and <code>org.codehaus</code> there is no requirement that an implementation should
5052
* report these inferred parent groupIds, it is just strongly encouraged.
@@ -61,6 +63,7 @@ public interface ArtifactStore
6163
Set<String> getGroupIds( String parentGroupId );
6264

6365
/**
66+
* <p>
6467
* Returns the set of artifactIds that belong in the specified groupId. Some implementations may be lazy caching
6568
* implementations, in which case it is permitted to return either the empty set, or only those entries which
6669
* 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
7780
Set<String> getArtifactIds( String groupId );
7881

7982
/**
83+
* <p>
8084
* Returns the set of versions of the specified groupId:artifactId. Some implementations may be lazy caching
8185
* implementations, in which case it is permitted to return either the empty set, or only those entries which
8286
* 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 )
200204

201205
/**
202206
*
203-
* @return
207+
* @return ArchetypeCatalog
204208
* @throws IOException if an I/O error occurs.
205209
* @throws ArchetypeCatalogNotFoundException if the archetypeCatalog does not exist.
206210
* @since 1.0
@@ -209,7 +213,7 @@ long getMetadataLastModified( String path )
209213

210214
/**
211215
*
212-
* @return
216+
* @return long
213217
* @throws IOException if an I/O error occurs.
214218
* @throws ArchetypeCatalogNotFoundException if the archetypeCatalog does not exist.
215219
* @since 1.0
@@ -218,7 +222,7 @@ long getMetadataLastModified( String path )
218222

219223
/**
220224
*
221-
* @param content
225+
* @param content the content
222226
* @throws IOException if an I/O error occurs.
223227
* @since 1.0
224228
*/

‎mrm-api/src/main/javadoc/org/codehaus/mojo/mrm/api/maven/package.html‎

Lines changed: 0 additions & 30 deletions
This file was deleted.

‎mrm-api/src/main/javadoc/org/codehaus/mojo/mrm/api/package.html‎

Lines changed: 0 additions & 31 deletions
This file was deleted.

‎mrm-api/src/main/javadoc/org/codehaus/mojo/mrm/plugin/package.html‎

Lines changed: 0 additions & 30 deletions
This file was deleted.

‎mrm-api/src/main/javadoc/overview.html‎

Lines changed: 0 additions & 39 deletions
This file was deleted.

‎mrm-maven-plugin/src/main/java/org/codehaus/mojo/mrm/plugin/RunMojo.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@
3030
* <code>settings.xml</code> and still work behind a proxy.
3131
*
3232
* @author Stephen Connolly
33-
* @description Starts a mock repository manager for manual testing.
33+
*
34+
* Starts a mock repository manager for manual testing.
3435
*/
3536
@Mojo( name = "run", requiresProject = false, requiresDirectInvocation = true, threadSafe = true )
3637
public class RunMojo

‎mrm-maven-plugin/src/main/java/org/codehaus/mojo/mrm/plugin/StartMojo.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@
3131
* <code>settings.xml</code> and still work behind a proxy.
3232
*
3333
* @author Stephen Connolly
34-
* @description Starts a mock repository manager as part of a maven build for use by integration tests.
34+
*
35+
* Starts a mock repository manager as part of a maven build for use by integration tests.
3536
*/
3637
@Mojo( name = "start", defaultPhase = LifecyclePhase.PRE_INTEGRATION_TEST, requiresProject = false, threadSafe = true )
3738
public class StartMojo

‎mrm-maven-plugin/src/main/java/org/codehaus/mojo/mrm/plugin/StopMojo.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@
2828
* <code>settings.xml</code> and still work behind a proxy.
2929
*
3030
* @author Stephen Connolly
31-
* @description Stops the mock repository manager started by <code>mrm:start</code> as part of a maven build for use
31+
*
32+
* Stops the mock repository manager started by <code>mrm:start</code> as part of a maven build for use
3233
* by integration tests.
3334
*/
3435
@Mojo( name = "stop", defaultPhase = LifecyclePhase.POST_INTEGRATION_TEST, requiresProject = false, threadSafe = true )

0 commit comments

Comments
 (0)