Class HelpDocument
java.lang.Object
io.spring.initializr.generator.spring.documentation.HelpDocument
Project's help document intended to give additional references to the users. Contains a
getting started section, additional sections and a next steps section.
- Author:
- Stephane Nicoll, Madhura Bhave
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddSection
(Section section) addSection
(String templateName, Map<String, Object> model) Add a section rendered by the specified mustache template and model.Return a section that can be used to inform the user that something happened when building this project.boolean
isEmpty()
void
write
(PrintWriter writer)
-
Constructor Details
-
HelpDocument
-
-
Method Details
-
getWarnings
Return a section that can be used to inform the user that something happened when building this project.- Returns:
- a warnings section rendered as bullet points
-
gettingStarted
-
nextSteps
-
addSection
-
addSection
Add a section rendered by the specified mustache template and model.- Parameters:
templateName
- the name of the mustache template to rendermodel
- the model that should be used for the rendering- Returns:
- this document
-
getSections
-
write
- Throws:
IOException
-
isEmpty
public boolean isEmpty()
-