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

Class AbstractFormatter

java.lang.Object

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

All Implemented Interfaces:

Formatter

Direct Known Subclasses:

AsciidocFormatter, MarkdownFormatter

abstract class AbstractFormatter
extends Object
implements Formatter

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	enableEnumTooltips
protected final GenerationReport	generationReport
protected final io.quarkus.annotation.processor.documentation.config.merger.JavadocRepository	javadocRepository

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
int	adjustedLevel(io.quarkus.annotation.processor.documentation.config.model.ConfigSection configSection, boolean multiRoot)
boolean	displayConfigRootDescription(io.quarkus.annotation.processor.documentation.config.merger.MergedModel.ConfigRootKey configRootKey, int mapSize)
String	escapeCellContent(String value)
protected abstract String	escapeDefaultValue(String defaultValue)
String	formatDefaultValue(io.quarkus.annotation.processor.documentation.config.model.ConfigProperty configProperty)
String	formatDeprecatedReason(io.quarkus.annotation.processor.documentation.config.model.ConfigProperty configProperty, io.quarkus.annotation.processor.documentation.config.model.Extension extension, GenerateConfigDocMojo.Context context)
String	formatDescription(io.quarkus.annotation.processor.documentation.config.model.ConfigProperty configProperty)
String	formatName(io.quarkus.annotation.processor.documentation.config.model.Extension extension)
String	formatSectionTitle(io.quarkus.annotation.processor.documentation.config.model.ConfigSection configSection)
String	formatTypeDescription(io.quarkus.annotation.processor.documentation.config.model.ConfigProperty configProperty, GenerateConfigDocMojo.Context context)
protected abstract io.quarkus.annotation.processor.documentation.config.model.JavadocFormat	javadocFormat()
protected abstract String	link(String href, String description)
protected abstract String	moreInformationAboutType(GenerateConfigDocMojo.Context context, String anchorRoot, String type)
String	toAnchor(String value)
protected abstract String	tooltip(String value, String javadocDescription)

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

Field Details

generationReport

protected final GenerationReport generationReport

javadocRepository

protected final io.quarkus.annotation.processor.documentation.config.merger.JavadocRepository javadocRepository

enableEnumTooltips

protected final boolean enableEnumTooltips

Constructor Details

AbstractFormatter

AbstractFormatter(GenerationReport generationReport,
 io.quarkus.annotation.processor.documentation.config.merger.JavadocRepository javadocRepository,
 boolean enableEnumTooltips)

Method Details

displayConfigRootDescription

public boolean displayConfigRootDescription(io.quarkus.annotation.processor.documentation.config.merger.MergedModel.ConfigRootKey configRootKey,
 int mapSize)

Specified by:

displayConfigRootDescription in interface Formatter

formatDescription

public String formatDescription(io.quarkus.annotation.processor.documentation.config.model.ConfigProperty configProperty)

Specified by:

formatDescription in interface Formatter

formatDeprecatedReason

public String formatDeprecatedReason(io.quarkus.annotation.processor.documentation.config.model.ConfigProperty configProperty,
 io.quarkus.annotation.processor.documentation.config.model.Extension extension,
 GenerateConfigDocMojo.Context context)

Specified by:

formatDeprecatedReason in interface Formatter

formatTypeDescription

public String formatTypeDescription(io.quarkus.annotation.processor.documentation.config.model.ConfigProperty configProperty,
 GenerateConfigDocMojo.Context context)

Specified by:

formatTypeDescription in interface Formatter

formatDefaultValue

public String formatDefaultValue(io.quarkus.annotation.processor.documentation.config.model.ConfigProperty configProperty)

Specified by:

formatDefaultValue in interface Formatter

adjustedLevel

public int adjustedLevel(io.quarkus.annotation.processor.documentation.config.model.ConfigSection configSection,
 boolean multiRoot)

Specified by:

adjustedLevel in interface Formatter

escapeCellContent

public String escapeCellContent(String value)

Specified by:

escapeCellContent in interface Formatter

toAnchor

public String toAnchor(String value)

Specified by:

toAnchor in interface Formatter

formatSectionTitle

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

Specified by:

formatSectionTitle in interface Formatter

formatName

public String formatName(io.quarkus.annotation.processor.documentation.config.model.Extension extension)

Specified by:

formatName in interface Formatter

javadocFormat

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

moreInformationAboutType

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

link

protected abstract String link(String href,
 String description)

tooltip

protected abstract String tooltip(String value,
 String javadocDescription)

escapeDefaultValue

protected abstract String escapeDefaultValue(String defaultValue)