Package com.puppycrawl.tools.checkstyle.site

Class SiteUtil.DescriptionExtractor

java.lang.Object

com.puppycrawl.tools.checkstyle.site.SiteUtil.DescriptionExtractor

Enclosing class:

SiteUtil

private static final class SiteUtil.DescriptionExtractor
extends Object

Utility class for extracting description from a method's Javadoc.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	DescriptionExtractor()

Method Summary

Modifier and Type	Method	Description
private static void	handleInternalLink(StringBuilder description, String moduleName, String value)	Converts the href value to a relative link to the document and appends it to the description.

Methods inherited from class java.lang.Object

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

Constructor Details

DescriptionExtractor

private DescriptionExtractor()

Method Details

handleInternalLink

private static void handleInternalLink(StringBuilder description,
 String moduleName,
 String value)
                                throws org.apache.maven.doxia.macro.MacroExecutionException

Converts the href value to a relative link to the document and appends it to the description.

Parameters:

description - the description to append the relative link to.

moduleName - the name of the module.

value - the href value.

Throws:

org.apache.maven.doxia.macro.MacroExecutionException - if the relative link could not be created.