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
|
//
// 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
//
extension Trait where Self == Comment {
/// Construct a comment related to a test from a single-line source code
/// comment near it.
///
/// - Parameters:
/// - comment: The comment about the test.
///
/// - Returns: An instance of ``Comment`` containing the specified comment.
///
/// - Warning: This function is used to implement the `@Test` macro. Do not
/// call it directly.
public static func __line(_ comment: String) -> Self {
Self(rawValue: comment, kind: .line)
}
/// Construct a comment related to a test from a source code block comment
/// near it.
///
/// - Parameters:
/// - comment: The comment about the test.
///
/// - Returns: An instance of ``Comment`` containing the specified comment.
///
/// - Warning: This function is used to implement the `@Test` macro. Do not
/// call it directly.
public static func __block(_ comment: String) -> Self {
Self(rawValue: comment, kind: .block)
}
/// Construct a comment related to a test from a single-line
/// [Markup](https://github.com/swiftlang/swift/blob/main/docs/DocumentationComments.md)
/// comment near it.
///
/// - Parameters:
/// - comment: The comment about the test.
///
/// - Returns: An instance of ``Comment`` containing the specified comment.
///
/// - Warning: This function is used to implement the `@Test` macro. Do not
/// call it directly.
public static func __documentationLine(_ comment: String) -> Self {
Self(rawValue: comment, kind: .documentationLine)
}
/// Construct a comment related to a test from a
/// [Markup](https://github.com/swiftlang/swift/blob/main/docs/DocumentationComments.md)
/// block comment near it.
///
/// - Parameters:
/// - comment: The comment about the test.
///
/// - Returns: An instance of ``Comment`` containing the specified comment.
///
/// - Warning: This function is used to implement the `@Test` macro. Do not
/// call it directly.
public static func __documentationBlock(_ comment: String) -> Self {
Self(rawValue: comment, kind: .documentationBlock)
}
}
|