Package org.springframework.modulith.docs

Class SpringAutoRestDocsDocumentationSource

java.lang.Object
org.springframework.modulith.docs.SpringAutoRestDocsDocumentationSource
All Implemented Interfaces:
DocumentationSource
class SpringAutoRestDocsDocumentationSource extends Object implements DocumentationSource
A DocumentationSource that uses metadata generated by Spring Auto REST Docs' Javadoc Doclet.
Author:
Oliver Drotbohm

  • Constructor Details

    • SpringAutoRestDocsDocumentationSource

      SpringAutoRestDocsDocumentationSource()

  • Method Details

    • getDocumentation

      public Optional<String> getDocumentation(com.tngtech.archunit.core.domain.JavaMethod method)
      Description copied from interface: DocumentationSource
      Returns the documentation to be used for the given JavaMethod.
      Specified by:
      getDocumentation in interface DocumentationSource
      Parameters:
      method - must not be null.
      Returns:
      will never be null.