Package org.springframework.modulith.docs

Interface DocumentationSource

All Known Implementing Classes:
CodeReplacingDocumentationSource, SpringModulithDocumentationSource
interface DocumentationSource
Interface to abstract different ways of looking up documentation for code abstractions.
Author:
Oliver Drotbohm

  • Method Details

    • getDocumentation

      Optional<String> getDocumentation(com.tngtech.archunit.core.domain.JavaMethod method)
      Returns the documentation to be used for the given JavaMethod.
      Parameters:
      method - must not be null.
      Returns:
      will never be null.

    • getDocumentation

      Optional<String> getDocumentation(com.tngtech.archunit.core.domain.JavaClass type)
      Returns the documentation to be used for the given JavaClass.
      Parameters:
      type - must not be null.
      Returns:
      will never be null.
      Since:
      1.3

    • getDocumentation

      Optional<String> getDocumentation(JavaPackage pkg)
      Returns the documentation for the given JavaPackage.
      Parameters:
      pkg - must not be null.
      Returns:
      will never be null.
      Since:
      2.0