SwiftDocC
FeatureFlags

Structure

FeatureFlags

A set of feature flags that conditionally enable (usually experimental) behavior in Swift-DocC.

struct FeatureFlags

Mentioned In

Adding Feature Flags

Topics

Initializers

Instance Properties

var isExperimentalCodeBlockAnnotationsEnabled: Bool
Whether or not experimental annotation of code blocks is enabled.
var isExperimentalDeviceFrameSupportEnabled: Bool
Whether or not experimental support for device frames on images and video is enabled.
var isExperimentalLinkHierarchySerializationEnabled: Bool
Whether or not experimental support for emitting a serialized version of the local link resolution information is enabled.
var isExperimentalOverloadedSymbolPresentationEnabled: Bool
Whether or not experimental support for combining overloaded symbol pages is enabled.
var isMentionedInEnabled: Bool
Whether support for automatically rendering links on symbol documentation to articles that mention that symbol is enabled.
var isParametersAndReturnsValidationEnabled: Bool
Whether or not support for validating parameters and return value documentation is enabled.

Type Properties

static var current: FeatureFlags
The current feature flags that Swift-DocC uses to conditionally enable (usually experimental) behavior in Swift-DocC.