Contents

AutomaticArticleSubheading

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

Declaration

@AutomaticArticleSubheading(_ enabledness: Enabledness)

Parameters

  • enabledness:

    Whether or not DocC generates automatic second-level “Overview” subheadings. (required)

    enabled

    An overview subheading should be automatically created for the article (the default).

    disabled

    No automatic overview subheading should be created for the article.

Overview

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.

See Also

Adjusting Automatic Behaviors