File: DocumentationAttr.swift

package info (click to toggle)
swiftlang 6.0.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,519,992 kB
  • sloc: cpp: 9,107,863; ansic: 2,040,022; asm: 1,135,751; python: 296,500; objc: 82,456; f90: 60,502; lisp: 34,951; pascal: 19,946; sh: 18,133; perl: 7,482; ml: 4,937; javascript: 4,117; makefile: 3,840; awk: 3,535; xml: 914; fortran: 619; cs: 573; ruby: 573
file content (47 lines) | stat: -rw-r--r-- 1,874 bytes parent folder | download
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
// RUN: %empty-directory(%t)
// RUN: %target-build-swift %s -module-name DocumentationAttr -emit-module -emit-module-path %t/
// RUN: %target-swift-symbolgraph-extract -module-name DocumentationAttr -I %t -pretty-print -output-dir %t
// RUN: %FileCheck %s --input-file %t/DocumentationAttr.symbols.json --check-prefix PUBLIC

// RUN: %target-swift-symbolgraph-extract -module-name DocumentationAttr -I %t -pretty-print -output-dir %t -minimum-access-level internal
// RUN: %FileCheck %s --input-file %t/DocumentationAttr.symbols.json --check-prefix INTERNAL

// RUN: %target-swift-symbolgraph-extract -module-name DocumentationAttr -I %t -pretty-print -output-dir %t -minimum-access-level private
// RUN: %FileCheck %s --input-file %t/DocumentationAttr.symbols.json --check-prefix PRIVATE

// This test is a mirror of SkipsPublicUnderscore.swift, but using `@_documentation`
// instead of underscored names.

public protocol PublicProtocol {}

// PUBLIC-NOT: ShouldntAppear
// INTERNAL-DAG: ShouldntAppear
// PRIVATE-DAG: ShouldntAppear

@_documentation(visibility: internal) public struct ShouldntAppear: PublicProtocol {
    public struct InnerShouldntAppear {}
}

public class SomeClass {
    // PUBLIC-NOT: internalVar
    // INTERNAL-NOT: internalVar
    // PRIVATE-DAG: internalVar
    @_documentation(visibility: private) internal var internalVar: String = ""
}

@_documentation(visibility: internal) public protocol ProtocolShouldntAppear {}

public struct PublicStruct: ProtocolShouldntAppear {
    @_documentation(visibility: internal) public struct InnerShouldntAppear {}
}

// The presence of `@_documentation(visibility: public)` should cause SymbolGraphGen to include an
// underscored enum case.

// PUBLIC-DAG: _ShouldAppear

public enum PublicEnum {
    case RegularCase
    case _ShouldntAppear
    @_documentation(visibility: public) case _ShouldAppear
}