Class Documenter.Options
java.lang.Object
org.springframework.modulith.docs.Documenter.Options
- Enclosing class:
- Documenter
-
Method Summary
Modifier and TypeMethodDescriptionstatic Documenter.Options
defaults()
Creates a defaultDocumenter.Options
instance configuring a default output folder based on the detected build tool (seeDocumenter.OutputFolder.DEFAULT_LOCATION
).(package private) Documenter.OutputFolder
Disables the cleaning of the output folder before any files are written.withOutputFolder
(String folder) Configures the output folder for the created files.
-
Method Details
-
defaults
Creates a defaultDocumenter.Options
instance configuring a default output folder based on the detected build tool (seeDocumenter.OutputFolder.DEFAULT_LOCATION
). UsewithOutputFolder(String)
if you want to customize the output folder. By default, the output folder is wiped before any files are written to it. UsewithoutClean()
to disable cleaning of the output folder.- Returns:
- will never be null.
- See Also:
-
withoutClean
Disables the cleaning of the output folder before any files are written.- Returns:
- will never be null.
-
withOutputFolder
Configures the output folder for the created files. The given directory is wiped before any files are written to it.- Parameters:
folder
- if null the default location based on the detected build tool will be used (seeDocumenter.OutputFolder.DEFAULT_LOCATION
). The given folder will be created if it does not exist already. Existing folders are supported as well.- Returns:
- will never be null.
-
getOutputFolder
Documenter.OutputFolder getOutputFolder()
-