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
  • Constructor Details

    • HelpDocumentProjectContributor

      public HelpDocumentProjectContributor(HelpDocument helpDocument)
  • Method Details

    • contribute

      public void contribute(Path projectRoot) throws IOException
      Description copied from interface: ProjectContributor
      Contribute additional resources to the project in the specified root directory.
      Specified by:
      contribute in interface ProjectContributor
      Parameters:
      projectRoot - the root directory of the project
      Throws:
      IOException - if contributing a resource failed