Package io.quarkus.maven.config.doc.generator

Class MarkdownFormatter

java.lang.Object

io.quarkus.maven.config.doc.generator.AbstractFormatter

io.quarkus.maven.config.doc.generator.MarkdownFormatter

All Implemented Interfaces:

Formatter

final class MarkdownFormatter
extends AbstractFormatter

Field Summary

Fields inherited from class io.quarkus.maven.config.doc.generator.AbstractFormatter

enableEnumTooltips, generationReport, javadocRepository

Constructor Summary

Constructors

Constructor	Description
MarkdownFormatter(GenerationReport generationReport, io.quarkus.annotation.processor.documentation.config.merger.JavadocRepository javadocRepository)

Method Summary

Modifier and Type	Method	Description
protected String	escapeDefaultValue(String defaultValue)
String	formatSectionTitle(io.quarkus.annotation.processor.documentation.config.model.ConfigSection configSection)
protected io.quarkus.annotation.processor.documentation.config.model.JavadocFormat	javadocFormat()
protected String	link(String href, String description)
protected String	moreInformationAboutType(GenerateConfigDocMojo.Context context, String anchorRoot, String type)
protected String	tooltip(String value, String javadocDescription)

Methods inherited from class io.quarkus.maven.config.doc.generator.AbstractFormatter

adjustedLevel, displayConfigRootDescription, escapeCellContent, formatDefaultValue, formatDeprecatedReason, formatDescription, formatName, formatTypeDescription, toAnchor

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.quarkus.maven.config.doc.generator.Formatter

formatDescription

Constructor Details

MarkdownFormatter

MarkdownFormatter(GenerationReport generationReport,
 io.quarkus.annotation.processor.documentation.config.merger.JavadocRepository javadocRepository)

Method Details

javadocFormat

protected io.quarkus.annotation.processor.documentation.config.model.JavadocFormat javadocFormat()

Specified by:

javadocFormat in class AbstractFormatter

formatSectionTitle

public String formatSectionTitle(io.quarkus.annotation.processor.documentation.config.model.ConfigSection configSection)

Specified by:

formatSectionTitle in interface Formatter

Overrides:

formatSectionTitle in class AbstractFormatter

moreInformationAboutType

protected String moreInformationAboutType(GenerateConfigDocMojo.Context context,
 String anchorRoot,
 String type)

Specified by:

moreInformationAboutType in class AbstractFormatter

link

protected String link(String href,
 String description)

Specified by:

link in class AbstractFormatter

tooltip

protected String tooltip(String value,
 String javadocDescription)

Specified by:

tooltip in class AbstractFormatter

escapeDefaultValue

protected String escapeDefaultValue(String defaultValue)

Specified by:

escapeDefaultValue in class AbstractFormatter