Package org.springframework.modulith.docs

@NullMarked package org.springframework.modulith.docs

Documentation support for Spring Modulith.

Related Packages

Package	Description
org.springframework.modulith	Core abstractions of Spring Modulith.
org.springframework.modulith.docs.metadata	Method and type documentation metadata.
org.springframework.modulith.docs.util	General utilities for the context of documentation generation.

Class	Description
Asciidoctor
CodeReplacingDocumentationSource	A DocumentationSource that replaces {@code …} or {@link …} blocks into inline code references
ConfigurationProperties	Represents all ConfigurationProperties.ConfigurationProperty instances found for the current project.
ConfigurationProperties.ConfigurationProperty
ConfigurationProperties.ModuleProperty
DocumentationSource	Interface to abstract different ways of looking up documentation for code abstractions.
Documenter	API to create documentation for ApplicationModules.
Documenter.CanvasOptions
Documenter.CanvasOptions.Grouping
Documenter.CanvasOptions.Groupings
Documenter.DiagramOptions	Options to tweak the rendering of diagrams.
Documenter.DiagramOptions.DiagramStyle	Different diagram styles.
Documenter.DiagramOptions.ElementsWithoutRelationships	Configuration setting to define whether modules that do not have a relationship to any other module shall be retained in the diagrams created.
Documenter.Options
Documenter.OutputFolder
Groupings	A collection of Documenter.CanvasOptions.Groupings.
Groupings.JMoleculesGroupings	jMolecules-related Documenter.CanvasOptions.Groupings.
Groupings.SpringGroupings	Spring Framework-related Documenter.CanvasOptions.Groupings.
SpringModulithDocumentationSource	A DocumentationSource using metadata found in "generated-spring-modulith/javadoc.json", usually generated via spring-modulith-apt.