Interface ImageConfig
public interface ImageConfig
Configuration for generated UML Diagram images.
- Author:
- Sjoerd Talsma
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionA separate directory where all UML diagram images are generated, if explicitly specified.formats()
Image format(s) to generate UML diagrams in.
-
Method Details
-
directory
A separate directory where all UML diagram images are generated, if explicitly specified.If not configured (i.e.
Optional.empty()
), the image will be generated within the same directory als the corresponding javadoc HTML.- Returns:
- The image directory for UML diagrams, if explicitly specified.
-
formats
Collection<ImageConfig.Format> formats()Image format(s) to generate UML diagrams in.By default
SVG
images will be generated because they are a lot smaller than for instancePNG
images and they can include links to JavadocHTML
pages.Providing one or more
"-umlImageFormat"
option values overrides this setting.- Returns:
- Image formats that will be generated (by default only
SVG
).
-