Package com.structurizr.documentation.template

Class DocumentationTemplate

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected com.structurizr.documentation.Documentation documentation  

    • Constructor Summary

      Constructors 
      Constructor Description
      DocumentationTemplate​(com.structurizr.documentation.Documentable documentable)
      Creates a new documentation template for the given workspace or software system.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.structurizr.documentation.Section addSection​(java.lang.String title, com.structurizr.documentation.Format format, java.lang.String content)
      Adds a documentation section.
      com.structurizr.documentation.Section addSection​(java.lang.String title, java.io.File... files)
      Adds a custom section from one or more files, that isn't related to any element in the model.
      protected com.structurizr.documentation.template.FormattedContent readFiles​(java.io.File... files)  

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • documentation

        protected com.structurizr.documentation.Documentation documentation

    • Constructor Detail

      • DocumentationTemplate

        public DocumentationTemplate​(com.structurizr.documentation.Documentable documentable)
        Creates a new documentation template for the given workspace or software system.
        Parameters:
        documentable - the Documentable object to create documentation for

    • Method Detail

      • addSection

        public com.structurizr.documentation.Section addSection​(java.lang.String title,
                                                        java.io.File... files)
                                                 throws java.io.IOException
        Adds a custom section from one or more files, that isn't related to any element in the model.
        Parameters:
        title - the section title
        files - one or more File objects that point to the documentation content
        Returns:
        a documentation Section
        Throws:
        java.io.IOException - if there is an error reading the files

      • addSection

        public com.structurizr.documentation.Section addSection​(java.lang.String title,
                                                        com.structurizr.documentation.Format format,
                                                        java.lang.String content)
        Adds a documentation section.
        Parameters:
        title - the section title
        format - the Format of the documentation content
        content - a String containing the documentation content
        Returns:
        a documentation Section

      • readFiles

        protected com.structurizr.documentation.template.FormattedContent readFiles​(java.io.File... files)
                                                                     throws java.io.IOException
        Throws:
        java.io.IOException