Package com.structurizr.importer.documentation

Class DefaultImageImporter

java.lang.Object

com.structurizr.importer.documentation.DefaultImageImporter

All Implemented Interfaces:

DocumentationImporter

public class DefaultImageImporter
extends Object
implements DocumentationImporter

This implementation scans a given directory and automatically imports all Markdown or AsciiDoc files in that directory. - Each file must represent a separate documentation section. - The second level heading ("## Section Title" in Markdown and "== Section Title" in AsciiDoc) will be used as the section title.

Constructor Summary

Constructors

Constructor	Description
DefaultImageImporter()

Method Summary

Modifier and Type	Method	Description
void	importDocumentation(com.structurizr.documentation.Documentable documentable, File path)	Imports one or more png/jpg/jpeg/gif images from the specified path.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultImageImporter

public DefaultImageImporter()

Method Details

importDocumentation

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

Imports one or more png/jpg/jpeg/gif images from the specified path.

Specified by:

importDocumentation in interface DocumentationImporter

Parameters:

documentable - the item that documentation should be associated with

path - the path to import images from