Package com.puppycrawl.tools.checkstyle.site

Class ModuleJavadocParsingUtil

java.lang.Object
com.puppycrawl.tools.checkstyle.site.ModuleJavadocParsingUtil
public final class ModuleJavadocParsingUtil extends Object
Utility class for parsing javadocs of modules.

  • Field Details

  • Constructor Details

  • Method Details

    • getPropertyNames

      public static Set<String> getPropertyNames(String moduleName) throws org.apache.maven.doxia.macro.MacroExecutionException
      Gets properties of the specified module.
      Parameters:
      moduleName - name of module.
      Returns:
      set of properties name if present, otherwise null.
      Throws:
      org.apache.maven.doxia.macro.MacroExecutionException - if the module could not be retrieved.

    • isStartOfNotesSection

      private static boolean isStartOfNotesSection(DetailNode htmlElement)
      Determines whether the given HTML node marks the start of the "Notes" section.
      Parameters:
      htmlElement - html element to check.
      Returns:
      true if the element starts the "Notes" section, false otherwise.

    • writeOutJavadocPortion

      public static void writeOutJavadocPortion(String javadocPortion, org.apache.maven.doxia.sink.Sink sink)
      Writes the given javadoc chunk into xdoc.
      Parameters:
      javadocPortion - javadoc text.
      sink - sink of the macro.

    • startsWithTextFormattingHtmlTag

      public static boolean startsWithTextFormattingHtmlTag(String line)
      Checks if given line starts with HTML text-formatting tag.
      Parameters:
      line - line to check on.
      Returns:
      whether given line starts with HTML text-formatting tag.

    • getModuleDescription

      public static String getModuleDescription(DetailNode moduleJavadoc)
      Gets the description of module from module javadoc.
      Parameters:
      moduleJavadoc - module javadoc.
      Returns:
      module description.

    • getDescriptionEndNode

      public static DetailNode getDescriptionEndNode(DetailNode moduleJavadoc)
      Gets the end node of the description.
      Parameters:
      moduleJavadoc - javadoc of module.
      Returns:
      the end index.

    • getNotesSectionStartNode

      public static DetailNode getNotesSectionStartNode(DetailNode moduleJavadoc)
      Gets the start node of the Notes section.
      Parameters:
      moduleJavadoc - javadoc of module.
      Returns:
      start node.

    • getModuleSinceVersionTagStartNode

      public static DetailNode getModuleSinceVersionTagStartNode(DetailNode moduleJavadoc)
      Gets the node representing the start of the @since version tag in the module's Javadoc.
      Parameters:
      moduleJavadoc - the root Javadoc node of the module
      Returns:
      the @since tag start node, or null if not found

    • getModuleNotes

      public static String getModuleNotes(DetailNode moduleJavadoc)
      Gets the Notes section of module from module javadoc.
      Parameters:
      moduleJavadoc - module javadoc.
      Returns:
      Notes section of module.

    • getNotesEndNode

      public static DetailNode getNotesEndNode(DetailNode moduleJavadoc)
      Gets the end node of the Notes.
      Parameters:
      moduleJavadoc - javadoc of module.
      Returns:
      the end index.

    • isPropertySpecialTokenProp

      public static boolean isPropertySpecialTokenProp(Field propertyField)
      Checks whether property is to contain tokens.
      Parameters:
      propertyField - property field.
      Returns:
      true if property is to contain tokens, false otherwise.