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
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2021 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
extension Semantic.Analyses {
/**
Checks to see if a directive has child markup content.
*/
public struct HasContent<Parent: Semantic & DirectiveConvertible>: SemanticAnalysis {
let additionalContext: String
public init(additionalContext: String? = nil) {
if let additionalContext,
!additionalContext.isEmpty {
self.additionalContext = "; \(additionalContext)"
} else {
self.additionalContext = ""
}
}
public func analyze(_ directive: BlockDirective, children: some Sequence<Markup>, source: URL?, for bundle: DocumentationBundle, in context: DocumentationContext, problems: inout [Problem]) -> MarkupContainer {
let children = Array(children)
guard children.isEmpty else {
return MarkupContainer(children)
}
let diagnostic = Diagnostic(source: source, severity: .warning, range: directive.range, identifier: "org.swift.docc.\(Parent.self).HasContent"
, summary: "\(Parent.directiveName.singleQuoted) directive has no content\(additionalContext)")
problems.append(Problem(diagnostic: diagnostic, possibleSolutions: []))
return MarkupContainer()
}
}
}
|
