Module spring.modulith.docs
Package org.springframework.modulith.docs

Class Asciidoctor

java.lang.Object
org.springframework.modulith.docs.Asciidoctor
class Asciidoctor extends Object
Author:
Oliver Drotbohm

  • Method Details

    • withJavadocBase

      public static Asciidoctor withJavadocBase(org.springframework.modulith.core.ApplicationModules modules, @Nullable String javadocBase)
      Creates a new Asciidoctor instance for the given ApplicationModules and Javadoc base URI.
      Parameters:
      modules - must not be null.
      javadocBase - can be null.
      Returns:
      will never be null.

    • withoutJavadocBase

      public static Asciidoctor withoutJavadocBase(org.springframework.modulith.core.ApplicationModules modules)
      Creates a new Asciidoctor instance for the given ApplicationModules.
      Parameters:
      modules - must not be null.
      Returns:
      will never be null.

    • toInlineCode

      public String toInlineCode(String source)
      Turns the given source string into inline code.
      Parameters:
      source - must not be null.
      Returns:

    • toInlineCode

      public String toInlineCode(com.tngtech.archunit.core.domain.JavaClass type)

    • toInlineCode

      public String toInlineCode(org.springframework.modulith.core.SpringBean bean)

    • renderSpringBeans

      public String renderSpringBeans(org.springframework.modulith.core.ApplicationModule module, Documenter.CanvasOptions options)

    • renderPublishedEvents

      public String renderPublishedEvents(org.springframework.modulith.core.ApplicationModule module)

    • renderEventsListenedTo

      public String renderEventsListenedTo(org.springframework.modulith.core.ApplicationModule module)

    • renderConfigurationProperties

      public String renderConfigurationProperties(List<ConfigurationProperties.ModuleProperty> properties)

    • typesToBulletPoints

      public String typesToBulletPoints(List<com.tngtech.archunit.core.domain.JavaClass> types)

    • toBulletPoint

      public String toBulletPoint(String source)

    • startTable

      public static String startTable(String tableSpec)

    • startOrEndTable

      public static String startOrEndTable()

    • writeTableRow

      public static String writeTableRow(String... columns)

    • toAsciidoctor

      public String toAsciidoctor(String source)

    • renderBeanReferences

      public String renderBeanReferences(org.springframework.modulith.core.ApplicationModule module)
      Parameters:
      module -
      Returns:

    • renderHeadline

      public String renderHeadline(int i, String modules)

    • renderPlantUmlInclude

      public String renderPlantUmlInclude(String componentsFilename)

    • renderGeneralInclude

      public String renderGeneralInclude(String componentsFilename)