Package software.amazon.smithy.docgen

Class SmithyDocPlugin

java.lang.Object

software.amazon.smithy.docgen.SmithyDocPlugin

All Implemented Interfaces:

SmithyBuildPlugin

public final class SmithyDocPlugin
extends Object
implements SmithyBuildPlugin

Generates API documentation from a Smithy model.

Constructor Summary

Constructors

Constructor	Description
SmithyDocPlugin()

Method Summary

Modifier and Type	Method	Description
void	execute(PluginContext pluginContext)	Executes the plugin, creating any number of artifacts.
String	getName()	Gets the name of the plugin.

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.build.SmithyBuildPlugin

isSerial, requiresValidModel

Constructor Details

SmithyDocPlugin

public SmithyDocPlugin()

Method Details

getName

public String getName()

Description copied from interface: SmithyBuildPlugin

Gets the name of the plugin.

Specified by:

getName in interface SmithyBuildPlugin

Returns:

Returns the name (e.g., "MyPlugin").

execute

public void execute(PluginContext pluginContext)

Description copied from interface: SmithyBuildPlugin

Executes the plugin, creating any number of artifacts.

Specified by:

execute in interface SmithyBuildPlugin

Parameters:

pluginContext - Plugin context for build execution.