Package com.puppycrawl.tools.checkstyle.site

Class DescriptionMacro

java.lang.Object
org.apache.maven.doxia.macro.AbstractMacro
com.puppycrawl.tools.checkstyle.site.DescriptionMacro
All Implemented Interfaces:
org.apache.maven.doxia.logging.LogEnabled, org.apache.maven.doxia.macro.Macro
@Component(role=org.apache.maven.doxia.macro.Macro.class, hint="description") public class DescriptionMacro extends org.apache.maven.doxia.macro.AbstractMacro
A macro that inserts a description of module from its Javadoc.

  • Field Summary

    Fields inherited from interface org.apache.maven.doxia.macro.Macro

    EOL, ROLE

  • Constructor Summary

    Constructors
    Constructor
    Description
    DescriptionMacro()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    execute(org.apache.maven.doxia.sink.Sink sink, org.apache.maven.doxia.macro.MacroRequest request)
     
    private static int
    getDescriptionEndIndex(DetailNode moduleJavadoc, Set<String> propertyNamesSet)
    Gets the end index of the description.

    Methods inherited from class org.apache.maven.doxia.macro.AbstractMacro

    enableLogging, getAttributesFromMap, getLog, required

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • execute

      public void execute(org.apache.maven.doxia.sink.Sink sink, org.apache.maven.doxia.macro.MacroRequest request) throws org.apache.maven.doxia.macro.MacroExecutionException
      Throws:
      org.apache.maven.doxia.macro.MacroExecutionException

    • getDescriptionEndIndex

      private static int getDescriptionEndIndex(DetailNode moduleJavadoc, Set<String> propertyNamesSet)
      Gets the end index of the description.
      Parameters:
      moduleJavadoc - javadoc of module.
      propertyNamesSet - Set with property names.
      Returns:
      the end index.