1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2022-2023 Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
See https://swift.org/CONTRIBUTORS.txt for Swift project authors
*/
import Foundation
import Markdown
/// A directive to adjust Swift-DocC's default behaviors when rendering a page.
///
/// ## Topics
///
/// ### Adjusting Automatic Behaviors
///
/// - ``AutomaticSeeAlso``
/// - ``AutomaticTitleHeading``
/// - ``AutomaticArticleSubheading``
///
/// ### Adjusting Visual Style
///
/// - ``TopicsVisualStyle``
public class Options: Semantic, AutomaticDirectiveConvertible {
public static let introducedVersion = "5.8"
public let originalMarkup: BlockDirective
/// Whether the options in this Options directive should apply locally to the page
/// or globally to the DocC catalog.
@DirectiveArgumentWrapped
public private(set) var scope: Scope = .local
@ChildDirective
public private(set) var _automaticSeeAlso: AutomaticSeeAlso? = nil
@ChildDirective
public private(set) var _automaticTitleHeading: AutomaticTitleHeading? = nil
@ChildDirective
public private(set) var _automaticArticleSubheading: AutomaticArticleSubheading? = nil
@ChildDirective
public private(set) var _topicsVisualStyle: TopicsVisualStyle? = nil
/// If given, whether or not automatic See Also section generation is enabled.
public var automaticSeeAlsoEnabled: Bool? {
return _automaticSeeAlso?.enabled
}
/// If given, whether or not automatic Title Heading generation is enabled.
public var automaticTitleHeadingEnabled: Bool? {
return _automaticTitleHeading?.enabled
}
/// If given, whether or not automatic article subheading generation is enabled.
public var automaticArticleSubheadingEnabled: Bool? {
return _automaticArticleSubheading?.enabled
}
/// If given, the authored style for a page's Topics section.
public var topicsVisualStyle: TopicsVisualStyle.Style? {
return _topicsVisualStyle?.style
}
/// A scope for the options provided by an Options directive.
public enum Scope: String, CaseIterable, DirectiveArgumentValueConvertible {
/// The directive should only affect the current page.
case local
/// The directive should affect all pages in the current DocC catalog.
case global
}
static var keyPaths: [String : AnyKeyPath] = [
"scope" : \Options._scope,
"_automaticSeeAlso" : \Options.__automaticSeeAlso,
"_automaticTitleHeading" : \Options.__automaticTitleHeading,
"_topicsVisualStyle" : \Options.__topicsVisualStyle,
"_automaticArticleSubheading" : \Options.__automaticArticleSubheading,
]
@available(*, deprecated, message: "Do not call directly. Required for 'AutomaticDirectiveConvertible'.")
required init(originalMarkup: BlockDirective) {
self.originalMarkup = originalMarkup
}
}
|
