DocRootTagConverter (Maven Plugin Tools 3.12.0 API)

java.lang.Object
- org.apache.maven.tools.plugin.extractor.annotations.converter.tag.JavadocTagToHtmlConverter
- - org.apache.maven.tools.plugin.extractor.annotations.converter.tag.inline.JavadocInlineTagToHtmlConverter
  - - org.apache.maven.tools.plugin.extractor.annotations.converter.tag.inline.DocRootTagConverter

@Named("docRoot")
@Singleton
public class DocRootTagConverter
extends JavadocInlineTagToHtmlConverter

Supports docRoot value tag.

- Constructor Summary
  
  Constructors
  Constructor Description
  
  DocRootTagConverter()
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  String convert(String text, ConverterContext context)
  - Methods inherited from class org.apache.maven.tools.plugin.extractor.annotations.converter.tag.JavadocTagToHtmlConverter
    escapeXmlElement
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DocRootTagConverter
```
public DocRootTagConverter()
```
- Method Detail
  - convert
```
public String convert(String text,
                      ConverterContext context)
```
    Specified by:
    
    convert in class JavadocTagToHtmlConverter
    
    Parameters:
    
    text - the value of the tag
    
    context - the content of the tag (may be empty in case there was no content given)
    
    Returns:
    
    the converted text which represents the tag with the given value in html