Uses of Class
org.springframework.modulith.docs.Documenter.CanvasOptions

Packages that use Documenter.CanvasOptions

Package	Description
org.springframework.modulith.docs	Documentation support for Spring Modulith.

Uses of Documenter.CanvasOptions in org.springframework.modulith.docs

Methods in org.springframework.modulith.docs that return Documenter.CanvasOptions

Modifier and Type	Method	Description
static Documenter.CanvasOptions	Documenter.CanvasOptions.defaults()	Creates a default Documenter.CanvasOptions instance configuring component Documenter.CanvasOptions.Groupings for jMolecules (if on the classpath) and Spring Framework.
Documenter.CanvasOptions	Documenter.CanvasOptions.groupingBy(String name, Predicate<org.springframework.modulith.core.SpringBean> filter)	Registers a component grouping with the given name and selecting filter.
Documenter.CanvasOptions	Documenter.CanvasOptions.groupingBy(String name, Predicate<org.springframework.modulith.core.SpringBean> filter, String description)	Registers a component grouping with the given name, selecting filter and description.
Documenter.CanvasOptions	Documenter.CanvasOptions.groupingBy(Documenter.CanvasOptions.Grouping... groupings)	Creates a new Documenter.CanvasOptions with the given Documenter.CanvasOptions.Groupings added.
Documenter.CanvasOptions	Documenter.CanvasOptions.revealEmptyLines()	Enables table rows not containing any values to be retained in the output.
Documenter.CanvasOptions	Documenter.CanvasOptions.revealInternals()	Enables the inclusion of internal components in the module canvas.
Documenter.CanvasOptions	Documenter.CanvasOptions.withApiBase(String apiBase)	Configures a URI string to act as the base of the Javadoc accessible for the types contained in the canvas.
static Documenter.CanvasOptions	Documenter.CanvasOptions.withoutDefaultGroupings()	Creates a Documenter.CanvasOptions instance that does not register any default component Documenter.CanvasOptions.Groupings.
Documenter.CanvasOptions	Documenter.CanvasOptions.withTargetFileName(String targetFileName)	Configures the target file name for the canvas to be written.

Methods in org.springframework.modulith.docs with parameters of type Documenter.CanvasOptions

Modifier and Type	Method	Description
String	Asciidoctor.renderSpringBeans(org.springframework.modulith.core.ApplicationModule module, Documenter.CanvasOptions options)
(package private) String	Documenter.toModuleCanvas(org.springframework.modulith.core.ApplicationModule module, Documenter.CanvasOptions options)
Documenter	Documenter.writeAggregatingDocument(Documenter.DiagramOptions diagramOptions, Documenter.CanvasOptions canvasOptions)	Writes aggregating document called all-docs.adoc that includes any existing component diagrams and canvases.
Documenter	Documenter.writeDocumentation(Documenter.DiagramOptions diagramOptions, Documenter.CanvasOptions canvasOptions)	Writes all available documentation: The entire set of modules as overview component diagram. Individual component diagrams per module to include all upstream modules. The Module Canvas for each module.
Documenter	Documenter.writeModuleCanvases(Documenter.CanvasOptions canvasOptions)	Writes all module canvases using the given Documenter.DiagramOptions.