Package org.hotswap.agent.distribution.markdown

Class MarkdownProcessor

  • public class MarkdownProcessor
extends java.lang.Object
    Discover plugin documentation, process a markdown document and convert to HTML.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String markdownToHtml​(java.lang.String src)
      Convert markdown to HTML
      boolean processPlugin​(java.lang.Class plugin, java.net.URL targetFile)
      Main method to process plugin documentation.
      java.lang.String resolveMarkdownDoc​(java.lang.Class plugin)
      Resolve README.md file from plugin package and from main plugin directory.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • MarkdownProcessor

        public MarkdownProcessor()

    • Method Detail

      • processPlugin

        public boolean processPlugin​(java.lang.Class plugin,
                             java.net.URL targetFile)
        Main method to process plugin documentation.
        Parameters:
        plugin - plugin class
        targetFile - file where to save HTML
        Returns:
        true if documentation is resolved and created

      • markdownToHtml

        public java.lang.String markdownToHtml​(java.lang.String src)
        Convert markdown to HTML
        Parameters:
        src - markdown content
        Returns:
        html content

      • resolveMarkdownDoc

        public java.lang.String resolveMarkdownDoc​(java.lang.Class plugin)
        Resolve README.md file from plugin package and from main plugin directory.
        Parameters:
        plugin - plugin class
        Returns:
        the content of README.md or null (if no documentation exists)