org.testingisdocumenting.znai.java.parser.html

Class HtmlToDocElementConverter

java.lang.Object

org.testingisdocumenting.znai.java.parser.html.HtmlToDocElementConverter

public class HtmlToDocElementConverter
extends Object

Method Summary

Modifier and Type	Method and Description
static List<DocElement>	convert(ComponentsRegistry componentsRegistry, Path filePath, String html, DocReferences codeReferences) converts html to doc elements so it can be re-used inside generated documentation

Methods inherited from class java.lang.Object

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

Method Detail

convert

public static List<DocElement> convert(ComponentsRegistry componentsRegistry,
                                       Path filePath,
                                       String html,
                                       DocReferences codeReferences)

converts html to doc elements so it can be re-used inside generated documentation

Parameters:

componentsRegistry - components like code parser

filePath - path to use by markup parser to handle include plugins resource location

html - html to parse

codeReferences - code references to use during conversion

Returns:

doc element that is a representation of th®e html