Skip to content

Commit 0b90014

Browse files
stefanseifertstefanseifert
authored
Fixes #413 - fix maven site generation (#414)
fix javadoc errors exclude modello-generated classes from javadocs remove plugin dependencies already defined (with newer versions) in parent pom
1 parent 9915931 commit 0b90014

12 files changed

Lines changed: 58 additions & 56 deletions

‎pom.xml‎

Lines changed: 11 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@
114114
<doxiaVersion>1.9.1</doxiaVersion>
115115
<doxia-sitetoolsVersion>1.7</doxia-sitetoolsVersion>
116116
<pluginVersion>${project.version}</pluginVersion>
117-
<sitePluginVersion>3.6</sitePluginVersion>
117+
<sitePluginVersion>3.7</sitePluginVersion>
118118
</properties>
119119

120120
<dependencies>
@@ -267,21 +267,6 @@
267267
<artifactId>modello-maven-plugin</artifactId>
268268
<version>1.11</version>
269269
</plugin>
270-
<plugin>
271-
<groupId>org.apache.maven.plugins</groupId>
272-
<artifactId>maven-gpg-plugin</artifactId>
273-
<version>1.6</version>
274-
</plugin>
275-
<plugin>
276-
<groupId>org.codehaus.mojo</groupId>
277-
<artifactId>animal-sniffer-maven-plugin</artifactId>
278-
<version>1.14</version>
279-
</plugin>
280-
<plugin>
281-
<groupId>org.apache.maven.plugins</groupId>
282-
<artifactId>maven-site-plugin</artifactId>
283-
<version>3.6</version>
284-
</plugin>
285270
</plugins>
286271
</pluginManagement>
287272
<plugins>
@@ -412,6 +397,16 @@
412397
<mavenOpts>-Xmx256m</mavenOpts>
413398
</configuration>
414399
</plugin>
400+
<plugin>
401+
<artifactId>maven-javadoc-plugin</artifactId>
402+
<configuration>
403+
<!-- Exclude packages generated by Modello in JavaDocs -->
404+
<excludePackageNames>
405+
org.codehaus.mojo.versions.model,
406+
org.codehaus.mojo.versions.model.io.xpp3
407+
</excludePackageNames>
408+
</configuration>
409+
</plugin>
415410
</plugins>
416411
</build>
417412

@@ -448,11 +443,6 @@
448443
</reportSet>
449444
</reportSets>
450445
</plugin>
451-
<plugin>
452-
<groupId>org.apache.maven.plugins</groupId>
453-
<artifactId>maven-project-info-reports-plugin</artifactId>
454-
<version>2.9</version>
455-
</plugin>
456446
</plugins>
457447
</reporting>
458448

‎src/main/java/org/codehaus/mojo/versions/AbstractVersionsDependencyUpdaterMojo.java‎

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ public abstract class AbstractVersionsDependencyUpdaterMojo
141141
/**
142142
* Should the project/dependencies section of the pom be processed.
143143
*
144-
* @return returns <code>true if the project/dependencies section of the pom should be processed.
144+
* @return returns <code>true</code> if the project/dependencies section of the pom should be processed.
145145
* @since 1.0-alpha-3
146146
*/
147147
public boolean isProcessingDependencies()
@@ -152,7 +152,7 @@ public boolean isProcessingDependencies()
152152
/**
153153
* Should the project/dependencyManagement section of the pom be processed.
154154
*
155-
* @return returns <code>true if the project/dependencyManagement section of the pom should be processed.
155+
* @return returns <code>true</code> if the project/dependencyManagement section of the pom should be processed.
156156
* @since 1.0-alpha-3
157157
*/
158158
public boolean isProcessingDependencyManagement()
@@ -163,7 +163,7 @@ public boolean isProcessingDependencyManagement()
163163
/**
164164
* Should the project/parent section of the pom be processed.
165165
*
166-
* @return returns <code>true if the project/parent section of the pom should be processed.
166+
* @return returns <code>true</code> if the project/parent section of the pom should be processed.
167167
* @since 2.3
168168
*/
169169
public boolean isProcessingParent()
@@ -174,7 +174,7 @@ public boolean isProcessingParent()
174174
/**
175175
* Should the artifacts produced in the current reactor be excluded from processing.
176176
*
177-
* @return returns <code>true if the artifacts produced in the current reactor should be excluded from processing.
177+
* @return returns <code>true</code> if the artifacts produced in the current reactor should be excluded from processing.
178178
* @since 1.0-alpha-3
179179
*/
180180
public boolean isExcludeReactor()
@@ -185,7 +185,7 @@ public boolean isExcludeReactor()
185185
/**
186186
* Should the dependency be updated itself or is it handled by properties.
187187
*
188-
* @param dependency
188+
* @param dependency Dependency
189189
* @return true if the version starts with '${'
190190
* @since 2.8
191191
*/
@@ -197,8 +197,8 @@ protected boolean isHandledByProperty(Dependency dependency) {
197197
/**
198198
* Try to find the dependency artifact that matches the given dependency.
199199
*
200-
* @param dependency
201-
* @return
200+
* @param dependency Dependency
201+
* @return Artifact
202202
* @since 1.0-alpha-3
203203
*/
204204
protected Artifact findArtifact( Dependency dependency )
@@ -222,8 +222,9 @@ protected Artifact findArtifact( Dependency dependency )
222222
/**
223223
* Try to find the dependency artifact that matches the given dependency.
224224
*
225-
* @param dependency
226-
* @return
225+
* @param dependency Dependency
226+
* @throws MojoExecutionException Mojo execution exception
227+
* @return Artifact
227228
* @since 1.0-alpha-3
228229
*/
229230
protected Artifact toArtifact( Dependency dependency )
@@ -344,8 +345,8 @@ private boolean compare( MavenProject project, Dependency dep )
344345
* Compare and artifact to a dependency. Returns true only if the groupId, artifactId, type, and classifier are all
345346
* equal.
346347
*
347-
* @param artifact
348-
* @param dep
348+
* @param artifact Artifact
349+
* @param dep Dependency
349350
* @return true if artifact and dep refer to the same artifact
350351
*/
351352
private boolean compare( Artifact artifact, Dependency dep )

‎src/main/java/org/codehaus/mojo/versions/AbstractVersionsReport.java‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,7 @@ protected void executeReport( Locale locale )
253253
* @param locale the locale to generate the report for.
254254
* @param sink the report formatting tool.
255255
* @throws MavenReportException when things go wrong.
256+
* @throws MojoExecutionException if something goes wrong.
256257
*/
257258
protected abstract void doGenerateReport( Locale locale, Sink sink )
258259
throws MavenReportException, MojoExecutionException;
@@ -263,9 +264,10 @@ protected abstract void doGenerateReport( Locale locale, Sink sink )
263264
* @param artifact The artifact.
264265
* @param versionRange The version range.
265266
* @param allowingSnapshots <code>null</code> for no override, otherwise the local override to apply.
267+
* @param usePluginRepositories Use plugin repositories
266268
* @return The latest version of the specified artifact that matches the specified version range or
267269
* <code>null</code> if no matching version could be found.
268-
* @throws MojoExecutionException If the artifact metadata could not be found.
270+
* @throws MavenReportException If the artifact metadata could not be found.
269271
* @since 1.0-alpha-1
270272
*/
271273
protected ArtifactVersion findLatestVersion( Artifact artifact, VersionRange versionRange,

‎src/main/java/org/codehaus/mojo/versions/AbstractVersionsUpdaterMojo.java‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -258,10 +258,11 @@ public void execute()
258258
* @param artifact The artifact.
259259
* @param versionRange The version range.
260260
* @param allowingSnapshots <code>null</code> for no override, otherwise the local override to apply.
261-
* @param usePluginRepositories
261+
* @param usePluginRepositories Use plugin repositories
262262
* @return The latest version of the specified artifact that matches the specified version range or
263263
* <code>null</code> if no matching version could be found.
264264
* @throws ArtifactMetadataRetrievalException If the artifact metadata could not be found.
265+
* @throws MojoExecutionException if something goes wrong.
265266
* @since 1.0-alpha-1
266267
*/
267268
protected ArtifactVersion findLatestVersion( Artifact artifact, VersionRange versionRange,
@@ -401,6 +402,7 @@ protected final void writeFile( File outFile, StringBuilder input )
401402
* @throws MojoExecutionException If things go wrong.
402403
* @throws MojoFailureException If things go wrong.
403404
* @throws javax.xml.stream.XMLStreamException If things go wrong.
405+
* @throws ArtifactMetadataRetrievalException if something goes wrong.
404406
* @since 1.0-alpha-1
405407
*/
406408
protected abstract void update( ModifiedPomXMLEventReader pom )
@@ -453,9 +455,9 @@ protected boolean shouldApplyUpdate( Artifact artifact, String currentVersion, A
453455
* Based on the passed flags, determines which segment is unchangable. This can be used when determining an upper
454456
* bound for the "latest" version.
455457
*
456-
* @param allowMajorUpdates
457-
* @param allowMinorUpdates
458-
* @param allowIncrementalUpdates
458+
* @param allowMajorUpdates Allow major updates
459+
* @param allowMinorUpdates Allow minor updates
460+
* @param allowIncrementalUpdates Allow incremental updates
459461
* @return Returns the segment that is unchangable. If any segment can change, returns -1.
460462
*/
461463
protected int determineUnchangedSegment( boolean allowMajorUpdates, boolean allowMinorUpdates,

‎src/main/java/org/codehaus/mojo/versions/CompareDependenciesMojo.java‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,6 @@ public class CompareDependenciesMojo
9191

9292
/**
9393
* Update dependency versions stored in properties
94-
*
95-
* @parameter property="updatePropertyVersions" default-value="false"
9694
*/
9795
@Parameter( property = "updatePropertyVersions", defaultValue = "false" )
9896
protected boolean updatePropertyVersions;

‎src/main/java/org/codehaus/mojo/versions/DependencyUpdatesXmlRenderer.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ public void render()
117117

118118
/**
119119
* Method wraps value in xml tag. In ex: to wrap foo in tag bar you have to pass foo as value and bar as tag. As a
120-
* result you will get: <bar>foo</bar>
120+
* result you will get: &lt;bar&gt;foo&lt;/bar&gt;
121121
*
122122
* @param value - string to wrap
123123
* @param tag - name of tag

‎src/main/java/org/codehaus/mojo/versions/api/DefaultVersionsHelper.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ public class DefaultVersionsHelper
180180
* Constructs a new {@link DefaultVersionsHelper}.
181181
*
182182
* @param artifactFactory The artifact factory.
183-
* @param artifactResolver
183+
* @param artifactResolver Artifact resolver
184184
* @param artifactMetadataSource The artifact metadata source to use.
185185
* @param remoteArtifactRepositories The remote artifact repositories to consult.
186186
* @param remotePluginRepositories The remote plugin repositories to consult.
@@ -193,6 +193,7 @@ public class DefaultVersionsHelper
193193
* @param mavenSession The maven session information.
194194
* @param pathTranslator The path translator component. @throws org.apache.maven.plugin.MojoExecutionException If
195195
* things go wrong.
196+
* @throws MojoExecutionException if something goes wrong.
196197
* @since 1.0-alpha-3
197198
*/
198199
public DefaultVersionsHelper( ArtifactFactory artifactFactory, ArtifactResolver artifactResolver,

‎src/main/java/org/codehaus/mojo/versions/api/PomHelper.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1572,9 +1572,9 @@ public static String getGAV( Model model )
15721572
/**
15731573
* Reads imported POMs from the dependency management section.
15741574
*
1575-
* @param pom
1575+
* @param pom POM
15761576
* @return a non-null list of {@link Dependency} for each imported POM
1577-
* @throws XMLStreamException
1577+
* @throws XMLStreamException XML stream exception
15781578
* @see <a href="https://github.com/mojohaus/versions-maven-plugin/issues/134">bug #134</a>
15791579
* @since 2.4
15801580
*/

‎src/main/java/org/codehaus/mojo/versions/api/UpdateScope.java‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
* Scopes of version updates.
3535
*
3636
* @author Stephen Connolly
37-
* @todo convert this class to a Java 1.5 enum once we move to Java 1.5
37+
* todo: convert this class to a Java 1.5 enum once we move to Java 1.5
3838
* @since 1.0-beta-1
3939
*/
4040
public abstract class UpdateScope
@@ -246,7 +246,6 @@ public ArtifactVersion[] getAllUpdates( VersionDetails versionDetails, ArtifactV
246246
* @param currentVersion The current version.
247247
* @param includeSnapshots Whether to include snapshots.
248248
* @return The next version within this scope or <code>null</code> if there is no version within this scope.
249-
* @throws ArtifactMetadataRetrievalException if there was a problem retrieving the list of available versions.
250249
*/
251250
public abstract ArtifactVersion getOldestUpdate( VersionDetails versionDetails, ArtifactVersion currentVersion,
252251
boolean includeSnapshots );
@@ -281,10 +280,11 @@ public abstract ArtifactVersion[] getAllUpdates( VersionDetails versionDetails,
281280

282281
/**
283282
* Returns the name of this enum constant, exactly as declared in its enum declaration.
284-
* <p/>
283+
* <p>
285284
* <b>Most programmers should use the {@link #toString} method in preference to this one, as the toString method may
286285
* return a more user-friendly name.</b> This method is designed primarily for use in specialized situations where
287286
* correctness depends on getting the exact name, which will not vary from release to release.
287+
* </p>
288288
*
289289
* @return the name of this enum constant
290290
*/
@@ -296,16 +296,18 @@ public final String name()
296296
/**
297297
* The ordinal of this enumeration constant (its position in the enum declaration, where the initial constant is
298298
* assigned an ordinal of zero).
299-
* <p/>
299+
* <p>
300300
* Most programmers will have no use for this field.
301+
* </p>
301302
*/
302303
private final int ordinal;
303304

304305
/**
305306
* Returns the ordinal of this enumeration constant (its position in its enum declaration, where the initial
306307
* constant is assigned an ordinal of zero).
307-
* <p/>
308+
* <p>
308309
* Most programmers will have no use for this method.
310+
* </p>
309311
*
310312
* @return the ordinal of this enumeration constant
311313
*/
@@ -366,9 +368,10 @@ protected final Object clone()
366368
/**
367369
* Compares this enum with the specified object for order. Returns a negative integer, zero, or a positive integer
368370
* as this object is less than, equal to, or greater than the specified object.
369-
* <p/>
371+
* <p>
370372
* Enum constants are only comparable to other enum constants of the same enum type. The natural order implemented
371373
* by this method is the order in which the constants are declared.
374+
* </p>
372375
*/
373376
public final int compareTo( Object o )
374377
{

‎src/main/java/org/codehaus/mojo/versions/api/VersionDetails.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ public interface VersionDetails
103103
* @param upperBound the upper bound or <code>null</code> if the upper limit is unbounded.
104104
* @param includeSnapshots <code>true</code> if snapshots are to be included.
105105
* @param includeLower <code>true</code> if the lower bound is inclusive.
106-
* @param includeUpper <code>true> if the upper bound is inclusive.
106+
* @param includeUpper <code>true</code> if the upper bound is inclusive.
107107
* @return all available versions within the specified version range.
108108
* @since 1.0-beta-1
109109
*/
@@ -119,7 +119,7 @@ ArtifactVersion[] getVersions( ArtifactVersion lowerBound, ArtifactVersion upper
119119
* @param upperBound the upper bound or <code>null</code> if the upper limit is unbounded.
120120
* @param includeSnapshots <code>true</code> if snapshots are to be included.
121121
* @param includeLower <code>true</code> if the lower bound is inclusive.
122-
* @param includeUpper <code>true> if the upper bound is inclusive.
122+
* @param includeUpper <code>true</code> if the upper bound is inclusive.
123123
* @return all available versions within the specified version range.
124124
* @since 1.0-beta-1
125125
*/
@@ -158,7 +158,7 @@ ArtifactVersion getNewestVersion( ArtifactVersion lowerBound, ArtifactVersion up
158158
* @param upperBound the upper bound or <code>null</code> if the upper limit is unbounded.
159159
* @param includeSnapshots <code>true</code> if snapshots are to be included.
160160
* @param includeLower <code>true</code> if the lower bound is inclusive.
161-
* @param includeUpper <code>true> if the upper bound is inclusive.
161+
* @param includeUpper <code>true</code> if the upper bound is inclusive.
162162
* @return the latest version between lowerBound and upperBound or <code>null</code> if no version is available.
163163
* @since 1.0-alpha-3
164164
*/
@@ -175,7 +175,7 @@ ArtifactVersion getNewestVersion( ArtifactVersion lowerBound, ArtifactVersion up
175175
* @param upperBound the upper bound or <code>null</code> if the upper limit is unbounded.
176176
* @param includeSnapshots <code>true</code> if snapshots are to be included.
177177
* @param includeLower <code>true</code> if the lower bound is inclusive.
178-
* @param includeUpper <code>true> if the upper bound is inclusive.
178+
* @param includeUpper <code>true</code> if the upper bound is inclusive.
179179
* @return the latest version between lowerBound and upperBound or <code>null</code> if no version is available.
180180
* @since 1.0-alpha-3
181181
*/
@@ -233,7 +233,7 @@ ArtifactVersion getOldestVersion( ArtifactVersion lowerBound, ArtifactVersion up
233233
* @param upperBound the upper bound or <code>null</code> if the upper limit is unbounded.
234234
* @param includeSnapshots <code>true</code> if snapshots are to be included.
235235
* @param includeLower <code>true</code> if the lower bound is inclusive.
236-
* @param includeUpper <code>true> if the upper bound is inclusive.
236+
* @param includeUpper <code>true</code> if the upper bound is inclusive.
237237
* @return the oldest version between lowerBound and upperBound or <code>null</code> if no version is available.
238238
* @since 1.0-beta-1
239239
*/
@@ -249,7 +249,7 @@ ArtifactVersion getOldestVersion( ArtifactVersion lowerBound, ArtifactVersion up
249249
* @param upperBound the upper bound or <code>null</code> if the upper limit is unbounded.
250250
* @param includeSnapshots <code>true</code> if snapshots are to be included.
251251
* @param includeLower <code>true</code> if the lower bound is inclusive.
252-
* @param includeUpper <code>true> if the upper bound is inclusive.
252+
* @param includeUpper <code>true</code> if the upper bound is inclusive.
253253
* @return the oldest version between lowerBound and upperBound or <code>null</code> if no version is available.
254254
* @since 1.0-beta-1
255255
*/

0 commit comments

Comments
 (0)