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
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 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 that controls what programming languages an article is available in.
///
/// By default, an article is available in the languages the module that's being documented is available in. Use
/// this directive to override this behavior in a ``Metadata`` directive:
///
/// ```
/// @Metadata {
/// @SupportedLanguage(swift)
/// @SupportedLanguage(objc)
/// }
/// ```
///
/// This directive supports any language identifier, but only the following are currently supported
/// by Swift-DocC Render:
///
/// | Identifier | Language |
/// | --------------------------------- | ----------------------|
/// | `swift` | Swift |
/// | `objc`, `objective-c` | Objective-C |
public final class SupportedLanguage: Semantic, AutomaticDirectiveConvertible {
public static let introducedVersion = "5.8"
public let originalMarkup: BlockDirective
/// A source language that this symbol is available in.
///
/// For supported values, see ``SupportedLanguage``.
@DirectiveArgumentWrapped(
name: .unnamed,
parseArgument: { _, argumentValue in
SourceLanguage(knownLanguageIdentifier: argumentValue)
?? SourceLanguage(id: argumentValue)
}
)
public var language: SourceLanguage
static var keyPaths: [String : AnyKeyPath] = [
"language": \SupportedLanguage._language,
]
@available(*, deprecated,
message: "Do not call directly. Required for 'AutomaticDirectiveConvertible'."
)
init(originalMarkup: BlockDirective) {
self.originalMarkup = originalMarkup
}
}
|
