Documentable

public protocol Documentable

A type that can be converted into a human-readable representation.

Show on GitHub

  • Convert an object to Markdown.

    Declaration

    Swift

    func markdown() -> String

    Return Value

    A Markdown string describing the object.

    Show on GitHub

  • Convert an object to a single line string.

    Declaration

    Swift

    func oneLiner() -> String

    Return Value

    A “one liner” describing the object.

    Show on GitHub

  • Indicate if the item has some content that is useful to document.

    Declaration

    Swift

    var hasContent: Bool { get }
    Show on GitHub

  • Convert an object to YAML as used in .swiftlint.yml.

    Declaration

    Swift

    func yaml() -> String

    Return Value

    A YAML snippet that can be used in configuration files.

    Show on GitHub