Skip to content

Commit 6cf6a44

Browse files
committed
Add some clarifying comments to XCFramework and related classes.
1 parent 2f26ab9 commit 6cf6a44

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

Sources/SWBCore/XCFramework.swift

+4
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,8 @@ public struct XCFramework: Hashable, Sendable {
249249
/// - macos
250250
/// - tvos
251251
/// - watchos
252+
///
253+
/// Note that a Mac Catalyst library will have a `platform` of 'ios' - not 'macos' - but a `platformVariant` of 'macabi'.
252254
public let supportedPlatform: String
253255

254256
/// The listing of supported architectures.
@@ -504,6 +506,8 @@ extension XCFramework.Library: Hashable {
504506

505507
/// This is an internal representation of the plist structure for v1 of the XCFramework. This is used in order to completely decouple the parsing structure from the actual data model structure. Doing this gains us better ability to version the XCFrameworks, and provides us a better mechanism to catch parsing errors vs. validation errors; if we only used the data model, certain validation errors would be lost in the `Codable` translation.
506508
///
509+
/// - remark: See the `XCFramework` struct and its nested structs for documentation about the individual fields. This struct only documents details about archiving the contents, not the meaning of the contents.
510+
///
507511
/// - remark: As time of writing this is the only version, and we can iterate on it as needed. If we ever radically transform the format (rather than just adding and removing keys) then we may create a new struct for the reworked version.
508512
@_spi(Testing) public struct XCFrameworkInfoPlist_V1: Codable {
509513
struct Library: Codable {

0 commit comments

Comments
 (0)