Package nl.talsmasoftware.umldoclet.configuration

Interface ImageConfig

public interface ImageConfig
Configuration relating to the images that are generated.
Author:
Sjoerd Talsma

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    ImageConfig.Format
    Supported image formats.

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<String>
    directory()
     
    Collection<ImageConfig.Format>
    formats()
    By default SVG images will be generated because they are a lot smaller than for instance PNG images and they can include links to Javadoc HTML pages.

  • Method Details

    • directory

      Optional<String> directory()
      Returns:
      The image directory for the UML diagrams, if explicitly specified.

    • formats

      Collection<ImageConfig.Format> formats()
      By default SVG images will be generated because they are a lot smaller than for instance PNG images and they can include links to Javadoc HTML pages.

      Providing one or more "-umlImageFormat" option values overrides this setting.

      Returns:
      The image formats that are generated (by default only SVG).