Package com.github.robtimus.maven.plugins.buildhelper

Class FixSiteAnchorsMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.github.robtimus.maven.plugins.buildhelper.FixSiteAnchorsMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="fix-site-anchors",
      defaultPhase=SITE,
      requiresProject=true,
      threadSafe=true)
public class FixSiteAnchorsMojo
extends org.apache.maven.plugin.AbstractMojo

Fixes anchors in URLs in site files.

If a Markdown file contains a link to a method's Javadoc, in modern Java versions this link contains ( and ). Even if these are escaped, the site plugin replaces these with .28 and .29 respectively. This mojo can be used to fix these incorrect replacements.

Author:

Rob Spoor

Since:

2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FixSiteAnchorsMojo.Replacement	A single replacement.

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
FixSiteAnchorsMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FixSiteAnchorsMojo

public FixSiteAnchorsMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException