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

Interface Formatter

All Known Implementing Classes:

AbstractFormatter, AsciidocFormatter, MarkdownFormatter

public interface Formatter

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)
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)
default String	formatDescription(io.quarkus.annotation.processor.documentation.config.model.ConfigProperty configProperty, io.quarkus.annotation.processor.documentation.config.model.Extension extension, GenerateConfigDocMojo.Context context)
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)
static Formatter	getFormatter(GenerationReport generationReport, io.quarkus.annotation.processor.documentation.config.merger.JavadocRepository javadocRepository, boolean enableEnumTooltips, Format format)
String	toAnchor(String value)

Method Details

displayConfigRootDescription

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

formatDescription

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

formatDescription

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

formatDeprecatedReason

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

formatTypeDescription

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

formatDefaultValue

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

adjustedLevel

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

escapeCellContent

String escapeCellContent(String value)

toAnchor

String toAnchor(String value)

formatSectionTitle

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

formatName

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

getFormatter

static Formatter getFormatter(GenerationReport generationReport,
 io.quarkus.annotation.processor.documentation.config.merger.JavadocRepository javadocRepository,
 boolean enableEnumTooltips,
 Format format)