Package software.amazon.smithy.traitcodegen.integrations.javadoc

Class JavaDocIntegration

java.lang.Object

software.amazon.smithy.traitcodegen.integrations.javadoc.JavaDocIntegration

All Implemented Interfaces:

SmithyIntegration<TraitCodegenSettings,TraitCodegenWriter,TraitCodegenContext>, TraitCodegenIntegration

public final class JavaDocIntegration
extends java.lang.Object
implements TraitCodegenIntegration

Adds all built-in Javadoc-generating interceptors.

This integration adds all the required documentation interceptors that ensure that methods, classes, and properties all have JavaDocs added.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	NAME

Constructor Summary

Constructors

Constructor	Description
JavaDocIntegration()

Method Summary

Modifier and Type	Method	Description
java.util.List<? extends CodeInterceptor<? extends CodeSection,TraitCodegenWriter>>	interceptors(TraitCodegenContext codegenContext)	Gets a list of CodeInterceptors to register with the AbstractCodeWriters created by the code generator.
java.lang.String	name()	Gets the name of the integration.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.smithy.codegen.core.SmithyIntegration

configure, customize, decorateSymbolProvider, preprocessModel, priority, runAfter, runBefore

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

JavaDocIntegration

public JavaDocIntegration()

Method Detail

name

public java.lang.String name()

Description copied from interface: SmithyIntegration

Gets the name of the integration.

This name is referred to when ordering the graph of integrations. The name defaults to the canonical class name if not overridden.

Specified by:

name in interface SmithyIntegration<TraitCodegenSettings,TraitCodegenWriter,TraitCodegenContext>

Returns:

Returns the integration name.

interceptors

public java.util.List<? extends CodeInterceptor<? extends CodeSection,TraitCodegenWriter>> interceptors(TraitCodegenContext codegenContext)

Description copied from interface: SmithyIntegration

Gets a list of CodeInterceptors to register with the AbstractCodeWriters created by the code generator.

This integration method should be called only after SmithyIntegration.preprocessModel(software.amazon.smithy.model.Model, S) and SmithyIntegration.decorateSymbolProvider(software.amazon.smithy.model.Model, S, software.amazon.smithy.codegen.core.SymbolProvider).

Specified by:

interceptors in interface SmithyIntegration<TraitCodegenSettings,TraitCodegenWriter,TraitCodegenContext>

Parameters:

codegenContext - Code generation context that can be queried when creating interceptors.

Returns:

Returns the list of CodeInterceptors.