Package com.structurizr.importer.documentation

Class DefaultDocumentationImporter

java.lang.Object

com.structurizr.importer.documentation.DefaultDocumentationImporter

All Implemented Interfaces:

DocumentationImporter

Direct Known Subclasses:

RecursiveDefaultDocumentationImporter

public class DefaultDocumentationImporter
extends Object
implements DocumentationImporter

This implementation scans a given directory and automatically imports all Markdown or AsciiDoc files in that directory. See https://structurizr.com/help/documentation/headings for details of how section headings and numbering are handled.

Constructor Summary

Constructors

Constructor	Description
DefaultDocumentationImporter()

Method Summary

Modifier and Type	Method	Description
void	importDocumentation(com.structurizr.documentation.Documentable documentable, File path)	Imports Markdown/AsciiDoc files from the specified path, each in its own section.
protected void	importFile(com.structurizr.documentation.Documentable documentable, File file)

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultDocumentationImporter

public DefaultDocumentationImporter()

Method Details

importDocumentation

public void importDocumentation(com.structurizr.documentation.Documentable documentable,
 File path)

Imports Markdown/AsciiDoc files from the specified path, each in its own section.

Specified by:

importDocumentation in interface DocumentationImporter

Parameters:

documentable - the item that documentation should be associated with

path - the path to import documentation from

importFile

protected void importFile(com.structurizr.documentation.Documentable documentable,
 File file)
                   throws Exception

Throws:

Exception