SwiftDocC
AutomaticArticleSubheading

Class

AutomaticArticleSubheading

A directive that modifies Swift-DocC’s default behavior for automatic subheading generation on article pages.

class AutomaticArticleSubheading

Discussion

By default, articles receive a second-level “Overview” heading unless the author explicitly writes some other H2 heading below the abstract. This allows for opting out of that behavior.

Topics

Instance Properties

var enabled: Bool
Whether or not DocC generates automatic second-level “Overview” subheadings.
var enabledness: AutomaticArticleSubheading.Enabledness
Whether or not DocC generates automatic second-level “Overview” subheadings.
let originalMarkup: BlockDirective

Type Properties

static let introducedVersion: String

Enumerations

enum Enabledness
A value that represent whether automatic subheading generation is enabled or disabled.