Skip to content

Commit f0ae707

Browse files
Add documentation comments to Proposal properties
1 parent 7d4188e commit f0ae707

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

Sources/EvolutionMetadataModel/Proposal.swift

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,17 +70,47 @@ Attributes are `var` variables and not `let` constants to make it easier to buil
7070
*/
7171

7272
public struct Proposal: Equatable, Sendable, Codable, Identifiable {
73+
74+
/// Proposal ID in the format _SE-NNNN_. For example: "SE-0147"
7375
public var id: String
76+
77+
/// Proposal title as a Markdown string
78+
///
79+
/// The contents depend on the proposal itself, but typically only backtick characters appear in titles to indicate code voice.
7480
public var title: String
81+
82+
/// Proposal summary as a Markdown string
7583
public var summary: String
84+
85+
/// Filename and relative link to the proposal in the repository
7686
public var link: String
87+
88+
/// SHA1 hash of the proposal version used as the metadata source
7789
public var sha: String
90+
91+
/// Array of proposal authors
7892
public var authors: [Person]
93+
94+
/// Proposal review manager
7995
public var reviewManager: Person
96+
97+
/// Proposal status
8098
public var status: Status
99+
100+
/// Optional array of tracking bugs
81101
public var trackingBugs: [TrackingBug]?
102+
103+
/// Optional array of implementation links
82104
public var implementation: [Implementation]?
105+
106+
/// Optional array of warnings
107+
///
108+
/// Present only if validation warnings were found when extracting metadata from this proposal.
83109
public var warnings: [Issue]?
110+
111+
/// Optional array of errors
112+
///
113+
/// Present only if validation errors were found when extracting metadata from this proposal.
84114
public var errors: [Issue]?
85115

86116
public init(id: String = "", title: String = "", summary: String = "", link: String = "", sha: String = "", authors: [Person] = [], reviewManager: Person = Person(), status: Status = .statusExtractionNotAttempted, trackingBugs: [TrackingBug]? = nil, implementation: [Implementation]? = nil, warnings: [Issue]? = nil, errors: [Issue]? = nil)

0 commit comments

Comments
 (0)