Package software.amazon.smithy.docgen.generators

Class MemberGenerator

java.lang.Object

software.amazon.smithy.docgen.generators.MemberGenerator

All Implemented Interfaces:

Runnable

public final class MemberGenerator
extends Object
implements Runnable

Generates documentation for shape members.

The output of this can be customized in a number of ways. To add details to or re-write particular sections, register an interceptor with SmithyIntegration.interceptors(C). The following sections will be present:

• MemberSection: Enables re-writing the documentation for specific members.
• ShapeMembersSection: Enables re-writing or overwriting the entire list of members, including changes made in other sections.
• ProtocolSection Enables adding traits that are specific to a particular protocol. This section will only be present if there are protocol traits applied to the service. If there are multiple protocol traits, this section will appear once per protocol.
• ProtocolsSection Enables modifying the tab group containing all the protocol traits for all the protocols.

To change the intermediate format (e.g. from markdown to restructured text), a new DocFormat needs to be introduced via DocIntegration.docFormats(software.amazon.smithy.docgen.DocSettings).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MemberGenerator.MemberListingType	The type of listing.

Constructor Summary

Constructors

Constructor	Description
MemberGenerator(DocGenerationContext context, DocWriter writer, Shape shape, MemberGenerator.MemberListingType listingType)	Constructs a MemberGenerator.

Method Summary

Modifier and Type	Method	Description
void	run()

Methods inherited from class java.lang.Object

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

Constructor Details

MemberGenerator

public MemberGenerator(DocGenerationContext context,
 DocWriter writer,
 Shape shape,
 MemberGenerator.MemberListingType listingType)

Constructs a MemberGenerator.

Parameters:

context - The context used to generate documentation.

writer - The writer to write to.

shape - The shape whose members are being generated.

listingType - The type of listing being generated.

Method Details

run

public void run()

Specified by:

run in interface Runnable