Package com.structurizr.importer.documentation

Class RecursiveDefaultDocumentationImporter

java.lang.Object

com.structurizr.importer.documentation.DefaultDocumentationImporter

com.structurizr.importer.documentation.RecursiveDefaultDocumentationImporter

All Implemented Interfaces:

DocumentationImporter

public class RecursiveDefaultDocumentationImporter
extends DefaultDocumentationImporter

This implementation extends the DefaultDocumentationImporter to recursively import documentation.

Constructor Summary

Constructors

Constructor	Description
RecursiveDefaultDocumentationImporter()

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.

Methods inherited from class com.structurizr.importer.documentation.DefaultDocumentationImporter

importFile

Methods inherited from class java.lang.Object

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

Constructor Details

RecursiveDefaultDocumentationImporter

public RecursiveDefaultDocumentationImporter()

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

Overrides:

importDocumentation in class DefaultDocumentationImporter

Parameters:

documentable - the item that documentation should be associated with

path - the path to import documentation from