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
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2021-2025 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
*/
public import Foundation
public import Markdown
/**
A semantic object formed from a directive after a series of semantic analysis checks.
*/
public protocol DirectiveConvertible {
/**
The name that must match to convert a `BlockDirective` to this type.
*/
static var directiveName: String { get }
/**
The earliest release of Swift-DocC that supports this directive.
*/
static var introducedVersion: String { get }
/**
The `BlockDirective` that was analyzed and converted to this ``Semantic`` object.
*/
var originalMarkup: BlockDirective { get }
/// Creates a semantic object from the parsed block directive markup and performs semantic analysis to verify that the semantic object is valid.
/// - Parameters:
/// - directive: The parsed block directive to create a semantic object from.
/// - source: The location of the source file that contains the markup for the parsed block directive.
/// - bundle: The documentation bundle that the source file belongs to.
/// - problems: An inout array of ``Problem`` to be collected for later diagnostic reporting.
init?(from directive: BlockDirective, source: URL?, for bundle: DocumentationBundle, problems: inout [Problem])
@available(*, deprecated, renamed: "init(from:source:for:problems:)", message: "Use 'init(from:source:for:problems:)' instead. This deprecated API will be removed after 6.2 is released")
init?(from directive: BlockDirective, source: URL?, for bundle: DocumentationBundle, in context: DocumentationContext, problems: inout [Problem])
/// Returns a Boolean value indicating whether the `DirectiveConvertible` recognizes the given directive.
///
/// - Parameter directive: The directive to check for conversion compatibility.
static func canConvertDirective(_ directive: BlockDirective) -> Bool
}
public extension DirectiveConvertible {
/// Returns a Boolean value indicating whether the `DirectiveConvertible` recognizes the given directive.
///
/// - Parameter directive: The directive to check for conversion compatibility.
static func canConvertDirective(_ directive: BlockDirective) -> Bool {
directiveName == directive.name
}
// Default implementation to avoid source breaking changes. Remove this after 6.2 is released.
init?(from directive: BlockDirective, source: URL?, for bundle: DocumentationBundle, problems: inout [Problem]) {
fatalError("Directive named \(directive.name) doesn't implement either 'init(from:source:for:problems:)' or 'init(from:source:for:in:problems:)'")
}
// Default implementation to new types don't need to implement a deprecated initializer. Remove this after 6.2 is released.
init?(from directive: BlockDirective, source: URL?, for bundle: DocumentationBundle, in context: DocumentationContext, problems: inout [Problem]) {
self.init(from: directive, source: source, for: bundle, problems: &problems)
}
}
|
