Class MarkdownProcessor
- java.lang.Object
-
- org.hotswap.agent.distribution.markdown.MarkdownProcessor
-
public class MarkdownProcessor extends Object
Discover plugin documentation, process a markdown document and convert to HTML.
-
-
Constructor Summary
Constructors Constructor Description MarkdownProcessor()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringmarkdownToHtml(String src)Convert markdown to HTMLbooleanprocessPlugin(Class plugin, URL targetFile)Main method to process plugin documentation.StringresolveMarkdownDoc(Class plugin)Resolve README.md file from plugin package and from main plugin directory.
-
-
-
Method Detail
-
processPlugin
public boolean processPlugin(Class plugin, URL targetFile)
Main method to process plugin documentation.- Parameters:
plugin- plugin classtargetFile- file where to save HTML- Returns:
- true if documentation is resolved and created
-
markdownToHtml
public String markdownToHtml(String src)
Convert markdown to HTML- Parameters:
src- markdown content- Returns:
- html content
-
-