Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions maven-plugin-plugin/src/site/apt/index.apt
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,14 @@ Maven Plugin Plugin

The Plugin Plugin has four goals:

* {{{./descriptor-mojo.html}plugin:descriptor}} generates a plugin descriptor,
* {{{./descriptor-goal.html}plugin:descriptor}} generates a plugin descriptor,

* {{{./addPluginArtifactMetadata-mojo.html}plugin:addPluginArtifactMetadata}} injects any plugin-specific artifact
* {{{./addPluginArtifactMetadata-goal.html}plugin:addPluginArtifactMetadata}} injects any plugin-specific artifact
metadata to the project's artifact, for subsequent installation and deployment,

* {{{./helpmojo-mojo.html}plugin:helpmojo}} generates a help mojo which describes all mojos in a plugin,
* {{{./helpmojo-goal.html}plugin:helpmojo}} generates a help mojo which describes all mojos in a plugin,

* {{{./help-mojo.html}plugin:help}} display help information on maven-plugin-plugin.
* {{{./help-goal.html}plugin:help}} display help information on maven-plugin-plugin.

[]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
* under the License.
*/

File touchFile = new File( basedir, "javasample-maven-plugin/target/site/touch-mojo.html" )
File touchFile = new File( basedir, "javasample-maven-plugin/target/site/touch-goal.html" )
assert touchFile.exists()
assert touchFile.isFile()
content = touchFile.text
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
File pluginInfo = new File( basedir, "target/site/plugin-info.html" );
assert pluginInfo.isFile()

File touchMojo = new File( basedir, "target/site/touch-mojo.html" );
File touchMojo = new File( basedir, "target/site/touch-goal.html" );
assert touchMojo.isFile()

return true;
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@
* specific language governing permissions and limitations
* under the License.
*/
assert new File( basedir, 'target/site/noop-mojo.html' ).exists()
assert new File( basedir, 'target/site/noop-goal.html' ).exists()

content = new File( basedir, 'target/site/noop-mojo.html' ).text
content = new File( basedir, 'target/site/noop-goal.html' ).text

assert content.contains( '<li>Since version: <code>1.0</code>.</li>' )
assert content.contains( '<td><code>-</code></td>' )
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
* under the License.
*/

generated = new File( basedir, "target/site/test-mojo.html").getText("UTF-8")
generated = new File( basedir, "target/site/test-goal.html").getText("UTF-8")

assert generated.contains("Mojo-Description with some non-ASCII characters: €àáâãäåæòóôõöø")
assert generated.contains("Parameter-Description with some non-ASCII characters: ÈÉÊË€")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
* under the License.
*/

assert new File( basedir, 'target/site/noop-mojo.html' ).isFile()
assert new File( basedir, 'target/site/report-mojo.html' ).isFile()
assert new File( basedir, 'target/site/noop-goal.html' ).isFile()
assert new File( basedir, 'target/site/report-goal.html' ).isFile()

def pluginInfo = new File( basedir, 'target/site/plugin-info.html' )
assert pluginInfo.isFile()
Expand All @@ -34,7 +34,7 @@ assert pluginInfo.text.contains('<div><strong>Deprecated.</strong> You don\'t us
assert pluginInfo.text.contains('Does nothing.')


def noopMojo = new File( basedir, 'target/site/noop-mojo.html' )
def noopMojo = new File( basedir, 'target/site/noop-goal.html' )
assert noopMojo.isFile()

// deprecated in table and details
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
* under the License.
*/

assert new File( basedir, 'target/site/noop-mojo.html' ).isFile()
assert new File( basedir, 'target/site/noop-goal.html' ).isFile()

def pluginInfo = new File( basedir, 'target/site/plugin-info.html' )
assert pluginInfo.isFile()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
* under the License.
*/

assert new File( basedir, 'target/site/noop-mojo.html' ).isFile()
assert new File( basedir, 'target/site/noop-goal.html' ).isFile()

def pluginInfo = new File( basedir, 'target/site/plugin-info.html' )
assert pluginInfo.isFile()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
* under the License.
*/

def mojoDoc = new File( basedir, 'target/site/test-mojo.html' )
def mojoDoc = new File( basedir, 'target/site/test-goal.html' )

assert mojoDoc.isFile()

Expand Down
6 changes: 3 additions & 3 deletions maven-plugin-report-plugin/src/it/plugin-report/verify.groovy
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
* under the License.
*/

assert new File( basedir, 'target/site/noop-mojo.html' ).isFile()
assert new File( basedir, 'target/site/report-mojo.html' ).isFile()
assert new File( basedir, 'target/site/noop-goal.html' ).isFile()
assert new File( basedir, 'target/site/report-goal.html' ).isFile()

def pluginInfo = new File( basedir, 'target/site/plugin-info.html' )
assert pluginInfo.isFile()
Expand All @@ -34,7 +34,7 @@ assert pluginInfo.text.contains('<div><strong>Deprecated.</strong> You don\'t us
assert pluginInfo.text.contains('Does nothing.')


def noopMojo = new File( basedir, 'target/site/noop-mojo.html' )
def noopMojo = new File( basedir, 'target/site/noop-goal.html' )
assert noopMojo.isFile()

// deprecated in table and details
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@

/**
* Generates the plugin's report: the plugin details page at <code>plugin-info.html</code>,
* and one <code><i>goal</i>-mojo.html</code> per goal.
* Relies on one output file from <a href="../maven-plugin-plugin/descriptor-mojo.html">plugin:descriptor</a>.
* and one <code><i>goal</i>-goal.html</code> per goal.
* Relies on one output file from <a href="../maven-plugin-plugin/descriptor-goal.html">plugin:descriptor</a>.
*
* @since 3.14.0
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ private void renderGoalsSection(boolean hasMavenReport) {
* Added ./ to define a relative path
* @see AbstractMavenReportRenderer#getValidHref(java.lang.String)
*/
String goalDocumentationLink = "./" + mojo.getGoal() + "-mojo.html";
String goalDocumentationLink = "./" + mojo.getGoal() + "-goal.html";
sink.tableCell();
link(goalDocumentationLink, goalName);
sink.tableCell_();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@

/**
* Generates the plugin's report: the plugin details page at <code>plugin-info.html</code>
* and one <code><i>goal</i>-mojo.html</code> per goal.
* Relies on one output file from <a href="../maven-plugin-plugin/descriptor-mojo.html">plugin:descriptor</a>.
* and one <code><i>goal</i>-goal.html</code> per goal.
* Relies on one output file from <a href="../maven-plugin-plugin/descriptor-goal.html">plugin:descriptor</a>.
*
* @author <a href="[email protected]">Stephane Nicoll</a>
* @author <a href="mailto:[email protected]">Vincent Siveton</a>
Expand Down Expand Up @@ -276,7 +276,7 @@ private void generateMojosDocumentation(PluginDescriptor pluginDescriptor, Local
for (MojoDescriptor descriptor : pluginDescriptor.getMojos()) {
GoalRenderer renderer;
try {
String filename = descriptor.getGoal() + "-mojo.html";
String filename = descriptor.getGoal() + "-goal.html";
Sink sink = getSinkFactory().createSink(getReportOutputDirectory(), filename);
renderer = new GoalRenderer(
sink,
Expand Down
4 changes: 2 additions & 2 deletions maven-plugin-report-plugin/src/site/apt/index.apt
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ Maven Plugin Report Plugin

The Plugin Report Plugin has two goals:

* {{{./report-mojo.html}plugin-report:report}} which generates the plugin documentation: one overview report and documentation for each plugin's goal (mojo).
* {{{./report-goal.html}plugin-report:report}} which generates the plugin documentation: one overview report and documentation for each plugin's goal (mojo).

* {{{./report-no-fork-mojo.html}plugin-report:report-no-fork}} which generates the plugin documentation: one overview report and documentation for each plugin's goal (mojo) without forking the <<<process-classes>>> phase again. Note that this goal does require generation of classes before site generation, e.g. by invoking <<<mvn clean verify site>>>.
* {{{./report-no-fork-goal.html}plugin-report:report-no-fork}} which generates the plugin documentation: one overview report and documentation for each plugin's goal (mojo) without forking the <<<process-classes>>> phase again. Note that this goal does require generation of classes before site generation, e.g. by invoking <<<mvn clean verify site>>>.

[]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ public URI getUrl(FullyQualifiedJavadocReference reference) {
// link to other mojo (only for fields = parameters or without member)
return new URI(
null,
"./" + mojoAnnotatedClass.getMojo().name() + "-mojo.html",
"./" + mojoAnnotatedClass.getMojo().name() + "-goal.html",
reference.getMember().orElse(null));
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ void testGetUrl() throws URISyntaxException {

// field reference in another mojo
assertEquals(
new URI(null, "./other-goal-mojo.html", "field1"),
new URI(null, "./other-goal-goal.html", "field1"),
context.getUrl(new FullyQualifiedJavadocReference(
currentPackageName, "OtherClass", "field1", MemberType.FIELD, false)));

Expand Down