Class DefaultImageImporter
- java.lang.Object
-
- com.structurizr.documentation.importer.DefaultImageImporter
-
- All Implemented Interfaces:
DocumentationImporter
public class DefaultImageImporter extends java.lang.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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidimportDocumentation(com.structurizr.documentation.Documentable documentable, java.io.File path)Imports one or more png/jpg/jpeg/gif images from the specified path.
-
-
-
Method Detail
-
importDocumentation
public void importDocumentation(com.structurizr.documentation.Documentable documentable, java.io.File path)Imports one or more png/jpg/jpeg/gif images from the specified path.- Specified by:
importDocumentationin interfaceDocumentationImporter- Parameters:
documentable- the item that documentation should be associated withpath- the path to import images from
-
-