ElementOptions

public struct ElementOptions : Codable

Options which and how elements shall be considered for class diagram generation

  • only elements (classes, structs, …) with the specified access level will be processed and rendered in the class diagram

    Declaration

    Swift

    public private(set) var havingAccessLevel: [AccessLevel] { get }

  • only members (properties and functions) with the specified access level will be processed and renderd in the class diagram

    Declaration

    Swift

    public private(set) var showMembersWithAccessLevel: [AccessLevel] { get }

  • show nested types

    Declaration

    Swift

    public private(set) var showNestedTypes: Bool { get }

  • show generic type and type constraint information for a struct/class (default: true)

    Declaration

    Swift

    public private(set) var showGenerics: Bool { get }

  • options which and how extensions shall be considered for class diagram generation (default: all)

    Declaration

    Swift

    public var showExtensions: ExtensionVisualization?

  • a suffix added to an extension member which will be displayed as part of the main type . You can use Emoji, OpenIconic, or any string

    Declaration

    Swift

    public private(set) var mergedExtensionMemberIndicator: String? { get }

  • show access level for members

    Declaration

    Swift

    public private(set) var showMemberAccessLevelAttribute: Bool { get }

  • exclude elements for given names (wildcard support with *), e.g. use *Test*to hide classes/structs/… who contain Test in their name

    Declaration

    Swift

    public private(set) var exclude: [String]? { get }

  • Declaration

    Swift

    public init(from decoder: Decoder) throws

  • memberwise initializer

    Declaration

    Swift

    public init(
    havingAccessLevel: [AccessLevel] = [.open, .public, .package, .internal, .private],
    showMembersWithAccessLevel: [AccessLevel] = [.open, .public, .package, .internal, .private],
    showNestedTypes: Bool = true,
    showGenerics: Bool = true,
    showExtensions: ExtensionVisualization? = nil,
    mergedExtensionMemberIndicator: String? = "<&bolt>",
    showMemberAccessLevelAttribute: Bool = true,
    exclude: [String]? = nil
)