Package org.eclipse.edc.plugins.autodoc.core.processor.introspection

Class OverviewIntrospector

java.lang.Object

org.eclipse.edc.plugins.autodoc.core.processor.introspection.OverviewIntrospector

public class OverviewIntrospector
extends Object

Generates a module overview.

Constructor Summary

Constructors

Constructor	Description
OverviewIntrospector(@Nullable JavadocConverter javadocConverter, Elements elementUtils)

Method Summary

Modifier and Type	Method	Description
@Nullable String	generateModuleOverview(org.eclipse.edc.runtime.metamodel.domain.ModuleType moduleType, RoundEnvironment environment)	Generated overview documentation by converting Javadoc to a Markdown representation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OverviewIntrospector

public OverviewIntrospector(@Nullable
 @Nullable JavadocConverter javadocConverter,
 Elements elementUtils)

Method Details

generateModuleOverview

@Nullable
public @Nullable String generateModuleOverview(org.eclipse.edc.runtime.metamodel.domain.ModuleType moduleType,
 RoundEnvironment environment)

Generated overview documentation by converting Javadoc to a Markdown representation. For SPI modules, the Javadoc is taken from the package-info.java type annotated with Spi. For extensions, the Javadoc is taken from the type annotated with Extension.