software.amazon.smithy.traitcodegen.integrations.javadoc.JavaDocIntegration Maven / Gradle / Ivy

Go to download
/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0
 */

package software.amazon.smithy.traitcodegen.integrations.javadoc;

import java.util.List;
import software.amazon.smithy.traitcodegen.TraitCodegenContext;
import software.amazon.smithy.traitcodegen.integrations.TraitCodegenIntegration;
import software.amazon.smithy.traitcodegen.writer.TraitCodegenWriter;
import software.amazon.smithy.utils.CodeInterceptor;
import software.amazon.smithy.utils.CodeSection;
import software.amazon.smithy.utils.ListUtils;
import software.amazon.smithy.utils.SmithyInternalApi;

/**
 * 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.
 */
@SmithyInternalApi
public final class JavaDocIntegration implements TraitCodegenIntegration  {
    public static final String NAME = "javadoc";

    @Override
    public String name() {
        return NAME;
    }

    @Override
    public List> interceptors(
            TraitCodegenContext codegenContext) {
        return ListUtils.of(
                new JavaDocInjectorInterceptor(),
                new ExternalDocumentationInterceptor(),
                new SinceInterceptor(),
                new DeprecatedInterceptor(),
                new DocumentationTraitInterceptor()
        );
    }
}