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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
// RUN: %empty-directory(%t)
// RUN: %target-swift-frontend %s -module-name InheritedDocs -emit-module -emit-module-path %t/InheritedDocs.swiftmodule -emit-module-source-info-path %t/InheritedDocs.swiftsourceinfo -emit-module-doc-path %t/InheritedDocs.swiftdoc
// RUN: %target-swift-symbolgraph-extract -module-name InheritedDocs -I %t -pretty-print -output-dir %t
// RUN: %FileCheck %s --input-file %t/InheritedDocs.symbols.json --check-prefixes CHECK,DOCS
// RUN: %FileCheck %s --input-file %t/InheritedDocs.symbols.json --check-prefixes IMPL
// RUN: %FileCheck %s --input-file %t/InheritedDocs.symbols.json --check-prefixes BONUS
// RUN: %FileCheck %s --input-file %t/InheritedDocs.symbols.json --check-prefixes BONUS-DOCS
// RUN: %FileCheck %s --input-file %t/InheritedDocs.symbols.json --check-prefixes EXTRA
// RUN: %FileCheck %s --input-file %t/InheritedDocs.symbols.json --check-prefixes LOCAL
// RUN: %FileCheck %s --input-file %t/InheritedDocs.symbols.json --check-prefixes SUPER
// RUN: %target-swift-symbolgraph-extract -module-name InheritedDocs -I %t -pretty-print -output-dir %t -skip-inherited-docs
// RUN: %FileCheck %s --input-file %t/InheritedDocs.symbols.json --check-prefixes CHECK,SKIP
// RUN: %FileCheck %s --input-file %t/InheritedDocs.symbols.json --check-prefixes IMPL
// RUN: %FileCheck %s --input-file %t/InheritedDocs.symbols.json --check-prefixes BONUS
// RUN: %FileCheck %s --input-file %t/InheritedDocs.symbols.json --check-prefixes BONUS-SKIP
// RUN: %FileCheck %s --input-file %t/InheritedDocs.symbols.json --check-prefixes EXTRA
// RUN: %FileCheck %s --input-file %t/InheritedDocs.symbols.json --check-prefixes LOCAL
// RUN: %FileCheck %s --input-file %t/InheritedDocs.symbols.json --check-prefixes SUPER
// RUN: %empty-directory(%t)
// RUN: %target-build-swift %s -module-name InheritedDocs -emit-module -emit-module-path %t/InheritedDocs.swiftmodule -emit-symbol-graph -emit-symbol-graph-dir %t/ -skip-inherited-docs
// RUN: %FileCheck %s --input-file %t/InheritedDocs.symbols.json --check-prefixes SKIP
// DOCS-COUNT-3: Some Function
// BONUS-DOCS-COUNT-2: Bonus docs!
// SKIP-COUNT-1: Some Function
// BONUS-SKIP-COUNT-1: Bonus docs!
// synthesized symbols should have a sourceOrigin field that points to where its docs come from
// CHECK: "source": "s:13InheritedDocs1PPAAE8someFuncyyF::SYNTHESIZED::s:13InheritedDocs1SV"
// CHECK-NEXT: "target": "s:13InheritedDocs1SV"
// CHECK-NEXT: "sourceOrigin"
// CHECK-NEXT: "identifier": "s:13InheritedDocs1PP8someFuncyyF"
// CHECK-NEXT: "displayName": "P.someFunc()"
// non-synthesized symbols that nonetheless inherit docs (like this extension) should have the same
// IMPL: "source": "s:13InheritedDocs1PPAAE8someFuncyyF"
// IMPL-NEXT: "target": "s:13InheritedDocs1PP8someFuncyyF"
// IMPL-NEXT: "sourceOrigin"
// IMPL-NEXT: "identifier": "s:13InheritedDocs1PP8someFuncyyF"
// IMPL-NEXT: "displayName": "P.someFunc()"
// synthesized symbols that point directly to their docs should also have a sourceOrigin field
// BONUS: "source": "s:13InheritedDocs1PPAAE9bonusFuncyyF::SYNTHESIZED::s:13InheritedDocs1SV"
// BONUS-NEXT: "target": "s:13InheritedDocs1SV"
// BONUS-NEXT: "sourceOrigin"
// BONUS-NEXT: "identifier": "s:13InheritedDocs1PPAAE9bonusFuncyyF"
// BONUS-NEXT: "displayName": "P.bonusFunc()"
// synthesized symbols that don't have docs to inherit still need to have the sourceOrigin field
// EXTRA: "source": "s:13InheritedDocs1PPAAE9extraFuncyyF::SYNTHESIZED::s:13InheritedDocs1SV"
// EXTRA-NEXT: "target": "s:13InheritedDocs1SV"
// EXTRA-NEXT: "sourceOrigin"
// EXTRA-NEXT: "identifier": "s:13InheritedDocs1PPAAE9extraFuncyyF"
// EXTRA-NEXT: "displayName": "P.extraFunc()"
// local implementations of a local protocol still need to a relation to that protocol
// LOCAL: "source": "s:13InheritedDocs1SV9localFuncyyF"
// LOCAL-NEXT: "target": "s:13InheritedDocs1SV"
// LOCAL-NEXT: "sourceOrigin"
// LOCAL-NEXT: "identifier": "s:13InheritedDocs1PP9localFuncyyF"
// LOCAL-NEXT: "displayName": "P.localFunc()"
// ...both with and without docs
// SUPER: "source": "s:13InheritedDocs1SV9superFuncyyF"
// SUPER-NEXT: "target": "s:13InheritedDocs1SV"
// SUPER-NEXT: "sourceOrigin"
// SUPER-NEXT: "identifier": "s:13InheritedDocs1PP9superFuncyyF"
// SUPER-NEXT: "displayName": "P.superFunc()"
/// Protocol P
public protocol P {
/// Some Function
func someFunc()
/// It's a local function!
func localFunc()
func superFunc()
}
public extension P {
func someFunc() {}
/// Bonus docs!
func bonusFunc() {}
func extraFunc() {} // no docs, but still needs sourceOrigin
}
public struct S: P {
public func localFunc() {}
public func superFunc() {}
}
|
