Package org.springframework.cloud.dataflow.app.plugin

Class ConfigurationMetadataDocumentationMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

org.springframework.cloud.dataflow.app.plugin.ConfigurationMetadataDocumentationMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="generate-documentation",
      requiresDependencyResolution=RUNTIME)
public class ConfigurationMetadataDocumentationMojo
extends org.apache.maven.plugin.AbstractMojo

A maven plugin that will scan an asciidoc file for special comment markers and replace everything in between with a listing of visible configuration properties for a Spring Cloud Stream/Task app. Applications with multiple properties prefixes are grouped by default. This can be disabled by using //tag::configuration-properties[group=false].

Author:

Eric Bottard, David Turanski

See Also:

• Whitelisting Properties

Field Summary

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
ConfigurationMetadataDocumentationMojo()

Method Summary

Modifier and Type	Method	Description
void	execute()

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Constructor Details

ConfigurationMetadataDocumentationMojo

public ConfigurationMetadataDocumentationMojo()

Method Details

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException