Class Documenter.Options

java.lang.Object
org.springframework.modulith.docs.Documenter.Options
Enclosing class:
Documenter

public static class Documenter.Options extends Object
  • Method Details

    • defaults

      public static Documenter.Options defaults()
      Creates a default Documenter.Options instance configuring a default output folder based on the detected build tool (see Documenter.OutputFolder.DEFAULT_LOCATION). Use withOutputFolder(String) if you want to customize the output folder. By default, the output folder is wiped before any files are written to it. Use withoutClean() to disable cleaning of the output folder.
      Returns:
      will never be null.
      See Also:
    • withoutClean

      public Documenter.Options withoutClean()
      Disables the cleaning of the output folder before any files are written.
      Returns:
      will never be null.
    • withOutputFolder

      public Documenter.Options withOutputFolder(@Nullable String folder)
      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 (see Documenter.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()