media query docs

Author: tib

Sources/SwiftHtml/MediaQuery.swift

@@ -5,42 +5,56 @@
 //  Created by Tibor Bodecs on 2022. 01. 24..
 //
 
+/// represents a CSS media query
 public struct MediaQuery {
 
+    /// device orientation
     public enum Orientation: String {
+        /// portrait orientation
         case portrait
+        /// landscape orientation
         case landscape
     }
 
+    /// device color scheme
     public enum ColorScheme: String {
+        /// light mode
         case light
+        /// dark mode
         case dark
     }
 
+    /// raw representation of the media query
     var value: String
 
 }
 
 public extension MediaQuery {
 
+    /// screen
     static let screen = MediaQuery(value: "screen")
 
+    /// device width in pixels
     static func deviceWidth(px: Int) -> MediaQuery {
         .init(value: "(device-width: \(px)px)")
     }
 
+    /// device height in pixels
     static func deviceHeight(px: Int) -> MediaQuery {
         .init(value: "(device-height: \(px)px)")
     }
 
+    /// device pixel ratio with webkit prefix
     static func webkitDevicePixelRatio(_ value: Int) -> MediaQuery {
         .init(value: "(-webkit-device-pixel-ratio: \(value))")
     }
 
+    /// device orientation
     static func orientation(_ value: Orientation) -> MediaQuery {
         .init(value: "(orientation: \(value.rawValue))")
     }
 
+    /// preferred color scheme
     static func prefersColorScheme(_ value: ColorScheme) -> MediaQuery {
         .init(value: "(prefers-color-scheme: \(value.rawValue))")
     }

Sources/SwiftHtml/Tags/A.swift

@@ -77,10 +77,16 @@ public extension A {
         attribute("media", value)
     }
 
+    /// Specifies what media/device the linked document is optimized for
+    ///
+    /// If multiple queries were provided they're going to be concatenated with an `and` operand
     func media(_ queries: MediaQuery...) -> Self {
         return media(queries)
     }
 
+    /// Specifies what media/device the linked document is optimized for
+    ///
+    /// If multiple queries were provided they're going to be concatenated with an `and` operand
     func media(_ queries: [MediaQuery]) -> Self {
         return media(queries.map(\.value).joined(separator: " and "))
     }

Sources/SwiftHtml/Tags/Area.swift

@@ -87,10 +87,16 @@ public extension Area {
         attribute("media", value)
     }
 
+    /// Specifies what media/device the linked document is optimized for
+    ///
+    /// If multiple queries were provided they're going to be concatenated with an `and` operand
     func media(_ queries: MediaQuery...) -> Self {
         return media(queries)
     }
 
+    /// Specifies what media/device the linked document is optimized for
+    ///
+    /// If multiple queries were provided they're going to be concatenated with an `and` operand
     func media(_ queries: [MediaQuery]) -> Self {
         return media(queries.map(\.value).joined(separator: " and "))
     }

Sources/SwiftHtml/Tags/Link.swift

@@ -93,10 +93,16 @@ public extension Link {
         attribute("media", value)
     }
 
+    /// Specifies what media/device the linked document is optimized for
+    ///
+    /// If multiple queries were provided they're going to be concatenated with an `and` operand
     func media(_ queries: MediaQuery...) -> Self {
         return media(queries)
     }
 
+    /// Specifies what media/device the linked document is optimized for
+    ///
+    /// If multiple queries were provided they're going to be concatenated with an `and` operand
     func media(_ queries: [MediaQuery]) -> Self {
         return media(queries.map(\.value).joined(separator: " and "))
     }

Sources/SwiftHtml/Tags/Meta.swift

@@ -83,14 +83,21 @@ public extension Meta {
         name(value.rawValue)
     }
 
+    /// Specifies what media/device the linked document is optimized for
     func media(_ value: String) -> Self {
         attribute("media", value)
     }
 
+    /// Specifies what media/device the linked document is optimized for
+    ///
+    /// If multiple queries were provided they're going to be concatenated with an `and` operand
     func media(_ queries: MediaQuery...) -> Self {
         return media(queries)
     }
 
+    /// Specifies what media/device the linked document is optimized for
+    ///
+    /// If multiple queries were provided they're going to be concatenated with an `and` operand
     func media(_ queries: [MediaQuery]) -> Self {
         return media(queries.map(\.value).joined(separator: " and "))
     }

Sources/SwiftHtml/Tags/Source.swift

@@ -24,10 +24,16 @@ public extension Source {
         attribute("media", value)
     }
 
+    /// Specifies what media/device the linked document is optimized for
+    ///
+    /// If multiple queries were provided they're going to be concatenated with an `and` operand
     func media(_ queries: MediaQuery...) -> Self {
         return media(queries)
     }
 
+    /// Specifies what media/device the linked document is optimized for
+    ///
+    /// If multiple queries were provided they're going to be concatenated with an `and` operand
     func media(_ queries: [MediaQuery]) -> Self {
         return media(queries.map(\.value).joined(separator: " and "))
     }

Sources/SwiftHtml/Tags/Style.swift

@@ -23,10 +23,16 @@ public extension Style {
         attribute("media", value)
     }
 
+    /// Specifies what media/device the linked document is optimized for
+    ///
+    /// If multiple queries were provided they're going to be concatenated with an `and` operand
     func media(_ queries: MediaQuery...) -> Self {
         return media(queries)
     }
 
+    /// Specifies what media/device the linked document is optimized for
+    ///
+    /// If multiple queries were provided they're going to be concatenated with an `and` operand
     func media(_ queries: [MediaQuery]) -> Self {
         return media(queries.map(\.value).joined(separator: " and "))
     }