Package com.structurizr.documentation
Class Documentation
java.lang.Object
com.structurizr.documentation.Documentation
Represents the documentation within a workspace, software system, container, or component;
a collection of content in Markdown or AsciiDoc format, optionally with attached images.
See Documentation
on the Structurizr website for more details.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addDecision
(Decision decision) Adds a new decision to this documentation.void
Adds an image to the documentation.void
addSection
(Section section) Adds a section to this documentation.void
clear()
Removes all documentation, decisions, and images.Gets the set of decisions associated with this workspace.Gets the set ofImage
s in this workspace.Gets the set ofSection
s.boolean
isEmpty()
-
Constructor Details
-
Documentation
public Documentation()
-
-
Method Details
-
addSection
Adds a section to this documentation.- Parameters:
section
- a Section object
-
getSections
Gets the set ofSection
s.- Returns:
- a Set of
Section
objects
-
getDecisions
Gets the set of decisions associated with this workspace.- Returns:
- a Set of Decision objects
-
addDecision
Adds a new decision to this documentation.- Parameters:
decision
- the Decision object
-
addImage
Adds an image to the documentation.- Parameters:
image
- an Image object
-
getImages
Gets the set ofImage
s in this workspace.- Returns:
- a Set of
Image
objects
-
isEmpty
public boolean isEmpty() -
clear
public void clear()Removes all documentation, decisions, and images.
-