Skip to content

Commit

Permalink
String literal form comes first in docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
Calyd committed Mar 23, 2022
1 parent 9fae59c commit febe1cf
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 24 deletions.
20 changes: 10 additions & 10 deletions Sources/MediaType/MediaType.swift
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,29 @@ import Foundation
/// media type instances simply using string literals.
///
/// ```swift
/// MediaType.application(.json()) // is equivalent to
/// let mediaType: MediaType = "application/json"
/// let mediaType: MediaType = "application/json" // is equivalent to
/// MediaType.application(.json())
/// ```
///
/// Media type suffixes and parameters are supported both via string literals and ``MediaType`` cases.
///
/// ```swift
/// MediaType.application(.atom(nil, ["charset": "utf-8"])) // is equivalent to
/// let mediaType: MediaType = "application/atom; charset=utf-8"
/// let mediaType: MediaType = "application/atom; charset=utf-8" // is equivalent to
/// MediaType.application(.atom(nil, ["charset": "utf-8"]))
///
/// MediaType.application(.atom(.xml)) // is equivalent to
/// let mediaType: MediaType = "application/atom+xml"
/// let mediaType: MediaType = "application/atom+xml" // is equivalent to
/// MediaType.application(.atom(.xml))
///
/// MediaType.application(.atom(.xml, ["charset": "utf-8"])) // is equivalent to
/// let mediaType: MediaType = "application/atom+xml; charset=utf-8"
/// let mediaType: MediaType = "application/atom+xml; charset=utf-8" // is equivalent to
/// MediaType.application(.atom(.xml, ["charset": "utf-8"]))
/// ```
///
/// You can create media type trees using either the string literal syntax, or using the `other` case of a particular
/// media type.
///
/// ```swift
/// MediaType.application(.other("vnd.efi.img")) // is equivalent to
/// "application/vnd.efi.img"
/// "application/vnd.efi.img" // is equivalent to
/// MediaType.application(.other("vnd.efi.img"))
/// ```
public enum MediaType {
/// Represents the `application` media type.
Expand Down
4 changes: 2 additions & 2 deletions Sources/MediaType/Parameters.swift
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ import Foundation
/// are also supported. The following examples are equivalent:
///
/// ```swift
/// let mediaType = MediaType.audio(.ac3(nil, ["rate": 32_000])) // is equivalent to
///
/// let mediaType: MediaType = "audio/ac3;rate=32000" // is equivalent to
///
/// let mediaType = MediaType.audio(.ac3(nil, ["rate": 32_000])) // is equivalent to
///
/// let rawMediaType = "audio/ac3;rate=32000"
/// let mediaType = MediaType(rawValue: rawMediaType)
/// ```
Expand Down
24 changes: 12 additions & 12 deletions UtilityScripts/SubtypeEnumGenerator.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -250,29 +250,29 @@ writeFileSync(
/// media type instances simply using string literals.
///
/// \`\`\`swift
/// MediaType.application(.json()) // is equivalent to
/// let mediaType: MediaType = "application/json"
/// let mediaType: MediaType = "application/json" // is equivalent to
/// MediaType.application(.json())
/// \`\`\`
///
/// Media type suffixes and parameters are supported both via string literals and \`\`MediaType\`\` cases.
///
/// \`\`\`swift
/// MediaType.application(.atom(nil, ["charset": "utf-8"])) // is equivalent to
/// let mediaType: MediaType = "application/atom; charset=utf-8"
/// let mediaType: MediaType = "application/atom; charset=utf-8" // is equivalent to
/// MediaType.application(.atom(nil, ["charset": "utf-8"]))
///
/// MediaType.application(.atom(.xml)) // is equivalent to
/// let mediaType: MediaType = "application/atom+xml"
/// let mediaType: MediaType = "application/atom+xml" // is equivalent to
/// MediaType.application(.atom(.xml))
///
/// MediaType.application(.atom(.xml, ["charset": "utf-8"])) // is equivalent to
/// let mediaType: MediaType = "application/atom+xml; charset=utf-8"
/// let mediaType: MediaType = "application/atom+xml; charset=utf-8" // is equivalent to
/// MediaType.application(.atom(.xml, ["charset": "utf-8"]))
/// \`\`\`
///
/// You can create media type trees using either the string literal syntax, or using the \`other\` case of a particular
/// media type.
///
/// \`\`\`swift
/// MediaType.application(.other("vnd.efi.img")) // is equivalent to
/// "application/vnd.efi.img"
/// "application/vnd.efi.img" // is equivalent to
/// MediaType.application(.other("vnd.efi.img"))
/// \`\`\`
public enum MediaType {
${
Expand Down Expand Up @@ -521,10 +521,10 @@ writeFileSync(
/// are also supported. The following examples are equivalent:
///
/// \`\`\`swift
/// let mediaType = MediaType.audio(.ac3(nil, ["rate": 32_000])) // is equivalent to
///
/// let mediaType: MediaType = "audio/ac3;rate=32000" // is equivalent to
///
/// let mediaType = MediaType.audio(.ac3(nil, ["rate": 32_000])) // is equivalent to
///
/// let rawMediaType = "audio/ac3;rate=32000"
/// let mediaType = MediaType(rawValue: rawMediaType)
/// \`\`\`
Expand Down

0 comments on commit febe1cf

Please sign in to comment.