Package io.spring.initializr.generator.spring.documentation

Class HelpDocumentProjectContributor

java.lang.Object

io.spring.initializr.generator.spring.documentation.HelpDocumentProjectContributor

All Implemented Interfaces:

ProjectContributor, org.springframework.core.Ordered

public class HelpDocumentProjectContributor
extends Object
implements ProjectContributor

ProjectContributor for the project's HELP.md file.

Author:

Stephane Nicoll, Madhura Bhave

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
HelpDocumentProjectContributor(HelpDocument helpDocument)

Method Summary

Modifier and Type	Method	Description
void	contribute(Path projectRoot)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.spring.initializr.generator.project.contributor.ProjectContributor

getOrder

Constructor Details

HelpDocumentProjectContributor

public HelpDocumentProjectContributor(HelpDocument helpDocument)

Method Details

contribute

public void contribute(Path projectRoot)
                throws IOException

Specified by:

contribute in interface ProjectContributor

Throws:

IOException