Package com.puppycrawl.tools.checkstyle.site

Class NotesMacro

java.lang.Object
org.apache.maven.doxia.macro.AbstractMacro
com.puppycrawl.tools.checkstyle.site.NotesMacro
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="notes") public class NotesMacro extends org.apache.maven.doxia.macro.AbstractMacro
A macro that inserts a notes subsection of module from its Javadoc.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Pattern
    NOTES_LINE_WITH_NEWLINE
    "Notes:" line with new line accounted.

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

    EOL, ROLE

  • Constructor Summary

    Constructors
    Constructor
    Description
    NotesMacro()
     

  • 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
    getNotesEndIndex(DetailNode moduleJavadoc, Set<String> propertyNamesSet)
    Gets the end index of the Notes.

    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

  • Field Details

  • 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

    • getNotesEndIndex

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