Package com.structurizr.documentation

Class Documentation

java.lang.Object
com.structurizr.documentation.Documentation
public final class Documentation extends Object
Represents the documentation within a workspace or software system - a collection of content in Markdown or AsciiDoc format, optionally with attached images. See Documentation on the Structurizr website for more details.

  • Constructor Details

    • Documentation

      public Documentation()

  • Method Details

    • addSection

      public void addSection(Section section)
      Adds a section to this documentation.
      Parameters:
      section - a Section object

    • getSections

      public Set<Section> getSections()
      Gets the set of Sections.
      Returns:
      a Set of Section objects

    • getDecisions

      public Set<Decision> getDecisions()
      Gets the set of decisions associated with this workspace.
      Returns:
      a Set of Decision objects

    • addDecision

      public void addDecision(Decision decision)
      Adds a new decision to this documentation.
      Parameters:
      decision - the Decision object

    • addImage

      public void addImage(Image image)
      Adds an image to the documentation.
      Parameters:
      image - an Image object

    • getImages

      public Set<Image> getImages()
      Gets the set of Images in this workspace.
      Returns:
      a Set of Image objects

    • isEmpty

      public boolean isEmpty()

    • clear

      public void clear()
      Removes all documentation, decisions, and images.