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

Packages that use Documenter

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

Uses of Documenter in org.springframework.modulith.docs

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

Modifier and Type	Method	Description
Documenter	Documenter.withOutputFolder(String outputFolder)	Deprecated, for removal: This API element is subject to removal in a future version. use Documenter(org.springframework.modulith.core.ApplicationModules,java.lang.String) directly.
Documenter	Documenter.writeDocumentation()	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. using Documenter.DiagramOptions.defaults() and Documenter.CanvasOptions.defaults().
Documenter	Documenter.writeDocumentation(Documenter.DiagramOptions options, 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.writeIndividualModulesAsPlantUml()
Documenter	Documenter.writeIndividualModulesAsPlantUml(Documenter.DiagramOptions options)	Writes the component diagrams for all individual modules.
Documenter	Documenter.writeModuleAsPlantUml(ApplicationModule module)	Writes the PlantUML component diagram for the given ApplicationModule.
Documenter	Documenter.writeModuleAsPlantUml(ApplicationModule module, Documenter.DiagramOptions options)	Writes the PlantUML component diagram for the given ApplicationModule with the given rendering Documenter.DiagramOptions.
Documenter	Documenter.writeModuleCanvases()	Writes all module canvases using Documenter.DiagramOptions.defaults().
Documenter	Documenter.writeModuleCanvases(Documenter.CanvasOptions options)	Writes all module canvases using the given Documenter.DiagramOptions.
Documenter	Documenter.writeModulesAsPlantUml()	Writes the PlantUML component diagram for all ApplicationModules using Documenter.DiagramOptions.defaults().
Documenter	Documenter.writeModulesAsPlantUml(Documenter.DiagramOptions options)	Writes the PlantUML component diagram for all ApplicationModules with the given Documenter.DiagramOptions.