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
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2021-2024 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 Markdown
/// Documentation about a symbol's return value.
public struct Return {
/// The content that describe the return value for a symbol.
public var contents: [Markup]
/// The text range where this return value was parsed.
var range: SourceRange?
/// Initialize a value to describe documentation about a symbol's return value.
/// - Parameters:
/// - contents: The content that describe the return value for this symbol.
/// - range: The text range where this return value was parsed.
public init(contents: [Markup], range: SourceRange? = nil) {
self.contents = contents
self.range = range
}
/// Initialize a value to describe documentation about a symbol's return value.
///
/// - Parameter doxygenReturns: A parsed Doxygen `\returns` command.
public init(_ doxygenReturns: DoxygenReturns) {
self.contents = Array(doxygenReturns.children)
self.range = doxygenReturns.range
}
}
|
