Package org.springframework.modulith.docs

Interface DocumentationSource

All Known Implementing Classes:

CodeReplacingDocumentationSource, SpringAutoRestDocsDocumentationSource, SpringModulithDocumentationSource

interface DocumentationSource

Interface to abstract different ways of looking up documentation for code abstractions.

Author:

Oliver Drotbohm

Method Summary

Modifier and Type	Method	Description
Optional<String>	getDocumentation(com.tngtech.archunit.core.domain.JavaClass type)	Returns the documentation to be used for the given JavaClass.
Optional<String>	getDocumentation(com.tngtech.archunit.core.domain.JavaMethod method)	Returns the documentation to be used for the given JavaMethod.

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