Skip to content

Commit a11b721

Browse files
Minor edits on PackageDescription source docs.
1 parent 0a9491b commit a11b721

File tree

4 files changed

+9
-14
lines changed

4 files changed

+9
-14
lines changed

Sources/PackageDescription4/BuildSettings.swift

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
See http://swift.org/CONTRIBUTORS.txt for Swift project authors
99
*/
1010

11-
/// The build configuration for a target.
11+
/// The build configuration such as debug or release..
1212
public struct BuildConfiguration: Encodable {
1313
private let config: String
1414

@@ -64,7 +64,7 @@ public struct BuildSettingCondition: Encodable {
6464
///
6565
/// - Parameters:
6666
/// - platforms: The applicable platforms for this build setting condition.
67-
/// - configuration: The applicable build configuration for this build setting condition.
67+
/// - configuration: The applicable build configuration for this build setting condition.
6868
public static func when(
6969
platforms: [Platform]? = nil,
7070
configuration: BuildConfiguration? = nil
@@ -225,7 +225,7 @@ public struct SwiftSetting: Encodable {
225225

226226
/// Define a compilation condition.
227227
///
228-
/// Use compilation conditions to only compile a statement if a certain condition is true.
228+
/// Use compilation conditions to only compile statements if a certain condition is true.
229229
/// For example, the Swift compiler will only compile the
230230
/// statements inside the `#if` block when `ENABLE_SOMETHING` is defined:
231231
///

Sources/PackageDescription4/LanguageStandardSettings.swift

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -61,12 +61,6 @@ public enum SwiftVersion {
6161

6262
extension SwiftVersion: Encodable {
6363

64-
/// Encodes this Swift version into the given encoder.
65-
///
66-
/// This function throws an error if any values are invalid for the given encoder’s format.
67-
///
68-
/// - Parameters:
69-
/// - encoder: The encoder to write data to.
7064
public func encode(to encoder: Encoder) throws {
7165
let value: String
7266

Sources/PackageDescription4/Package.swift

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,10 @@ import Foundation
5454
/// // swift-tools-version:3.1
5555
/// // swift-tools-version:4.0
5656
/// // swift-tools-version:5.0
57+
/// // swift-tools-version:5.1
5758
///
5859
/// The Swift tools version declares the version of the `PackageDescription`
59-
/// framework, the minimum version of the Swift tools and Swift language
60+
/// library, the minimum version of the Swift tools and Swift language
6061
/// compatibility version to process the manifest, and the minimum version of the
6162
/// Swift tools that are needed to use the Swift package. Each version of Swift
6263
/// can introduce updates to the `PackageDescription` framework, but the previous
@@ -76,7 +77,7 @@ public final class Package {
7677
/// Swift package can use. The `Package.resolved` file records the results of the
7778
/// dependency resolution and lives in the top-level directory of a Swift package.
7879
/// If you add the Swift package as a package dependency to an app for an Apple platform,
79-
/// you can find the `Package.resolved` file inside your `.xcodeproj` or `.xcodeworkspace`.
80+
/// you can find the `Package.resolved` file inside your `.xcodeproj` or `.xcworkspace`.
8081
public class Dependency: Encodable {
8182

8283
/// An enum that represents the requirement for a package dependency.
@@ -163,7 +164,7 @@ public final class Package {
163164
public var name: String
164165

165166
#if !PACKAGE_DESCRIPTION_4
166-
/// The list of platforms that this Swift package supports.
167+
/// The list of supported platforms with a custom deployment target.
167168
@available(_PackageDescription, introduced: 5)
168169
public var platforms: [SupportedPlatform]? {
169170
get { return _platforms }
@@ -331,7 +332,7 @@ public final class Package {
331332
}
332333
}
333334

334-
/// The system package providers that support Swift packages.
335+
/// The system package providers used in this Swift package.
335336
public enum SystemPackageProvider {
336337

337338
#if PACKAGE_DESCRIPTION_4

Sources/PackageDescription4/PackageDependency.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
extension Package.Dependency {
1212

13-
/// Create a package dependency that uses the version rule, starting with the given minimum version,
13+
/// Create a package dependency that uses the version requirement, starting with the given minimum version,
1414
/// going up to the next major version.
1515
///
1616
/// This is the recommended way to specify a remote package dependency.

0 commit comments

Comments
 (0)