From b20475483e7b695c276dcc8c8dbd630e3752586f Mon Sep 17 00:00:00 2001 From: Pierre-Yves Lapersonne Date: Thu, 21 Nov 2024 14:20:42 +0100 Subject: [PATCH] style: line breaks and comments for doc (#279) Signed-off-by: Pierre-Yves Lapersonne --- OUDS/Core/Themes/Inverse/Sources/InverseTheme.swift | 2 +- .../Sources/Declarations/ColorRawTokens.swift | 2 +- .../Sources/Declarations/DimensionRawTokens.swift | 2 +- .../Sources/Declarations/ElevationRawTokens.swift | 2 +- .../Sources/Declarations/GridRawTokens.swift | 2 +- .../Sources/Declarations/OpacityRawTokens.swift | 2 +- .../Sources/Declarations/TypographyRawTokens.swift | 2 +- .../TypeAliases/BorderRawTokens+Aliases.swift | 10 +++++----- .../TypeAliases/TypographyRawTokens+Aliases.swift | 10 +++++----- .../Sources/Multiples/MultipleElevationTokens.swift | 12 ++++++++---- .../Sources/Multiples/MultipleFontSizeTokens.swift | 2 +- .../Sources/Multiples/MultipleSizeTokens.swift | 2 +- .../Sources/Multiples/MultipleSpaceTokens.swift | 4 ++-- .../Sources/Multiples/MultipleTypographyTokens.swift | 6 +++--- .../TypeAliases/BorderSemanticTokens+Aliases.swift | 6 +++--- .../ElevationSemanticTokens+Aliases.swift | 2 +- .../Sources/Values/BorderSemanticTokens.swift | 4 ++-- .../Sources/Values/ColorMultipleSemanticTokens.swift | 2 +- .../Sources/Values/ColorSemanticTokens.swift | 4 ++-- .../Sources/Values/DimensionSemanticTokens.swift | 4 ++-- .../Values/ElevationCompositeSemanticTokens.swift | 5 ++--- .../Values/ElevationMultipleSemanticTokens.swift | 2 +- .../Sources/Values/ElevationSemanticTokens.swift | 7 +++---- .../Sources/Values/GridSemanticTokens.swift | 4 ++-- .../Sources/Values/OpacitySemanticTokens.swift | 5 +++-- .../Sources/Values/SizeMultipleSemanticTokens.swift | 4 ++-- .../Sources/Values/SizeSemanticTokens.swift | 4 ++-- .../Sources/Values/SpaceMultipleSemanticTokens.swift | 4 ++-- .../Sources/Values/SpaceSemanticTokens.swift | 4 ++-- .../Values/TypographyCompositeSemanticTokens.swift | 4 ++-- .../Values/TypographyMultipleSemanticTokens.swift | 4 ++-- .../Sources/Values/TypographySemanticTokens.swift | 5 ++--- 32 files changed, 68 insertions(+), 66 deletions(-) diff --git a/OUDS/Core/Themes/Inverse/Sources/InverseTheme.swift b/OUDS/Core/Themes/Inverse/Sources/InverseTheme.swift index fa9bf1c3f7..5e764fe3d4 100644 --- a/OUDS/Core/Themes/Inverse/Sources/InverseTheme.swift +++ b/OUDS/Core/Themes/Inverse/Sources/InverseTheme.swift @@ -13,7 +13,7 @@ import OUDSThemesOrange -/// This is an override of the default basic ``OrangeTheme`` with some inverted colors. +/// This is an override of the default basic `OrangeTheme` with some inverted colors. /// It can overrides any properties from its superclass, and can be derived too. open class InverseTheme: OrangeTheme, @unchecked Sendable { diff --git a/OUDS/Core/Tokens/RawTokens/Sources/Declarations/ColorRawTokens.swift b/OUDS/Core/Tokens/RawTokens/Sources/Declarations/ColorRawTokens.swift index 8a5a3e63ab..9dcdc8377d 100644 --- a/OUDS/Core/Tokens/RawTokens/Sources/Declarations/ColorRawTokens.swift +++ b/OUDS/Core/Tokens/RawTokens/Sources/Declarations/ColorRawTokens.swift @@ -14,7 +14,7 @@ /// Defined as the group of all **raw tokens** related to **colors**. /// Values are defined in *ColorRawTokens+Values.swift* file and generated by the tokenator. /// ``ColorRawTokens`` are tokens to use to define *colors* of components thants to ``ColorRawToken`` type. Some of these colors are "raw", and others have transparancy effects. -/// This enum contains also the shared colors, i.e. colors exposed to any theme. Some colors related to the Orange brand are defined elswhere in ``OrangeBrandColorRawTokens``. +/// This enum contains also the shared colors, i.e. colors exposed to any theme. Some colors related to the Orange brand are defined elswhere in `OrangeBrandColorRawTokens`. /// /// Primitive types such as ``String` must be used to as to allow to use `@objc` keywords in extensions for overriding. /// Such tokens are packed in a _Swift enum_ so as to gather them in one object with the suitable namespace and avoid to have just constants in nothing else diff --git a/OUDS/Core/Tokens/RawTokens/Sources/Declarations/DimensionRawTokens.swift b/OUDS/Core/Tokens/RawTokens/Sources/Declarations/DimensionRawTokens.swift index 312988d9b2..45ffa73619 100644 --- a/OUDS/Core/Tokens/RawTokens/Sources/Declarations/DimensionRawTokens.swift +++ b/OUDS/Core/Tokens/RawTokens/Sources/Declarations/DimensionRawTokens.swift @@ -15,7 +15,7 @@ /// Values are defined in *DimensionRawTokens+Values.swift* file and generated by the tokenator. /// ``DimensionRawTokens`` are tokens to use to define *dimensions* , i.e. kind of values to use for sizes or spaces thanks to ``DimensionRawToken``. /// -/// Primitive types such as ``Double`` must be used to as to allow to use `@objc` keywords in extensions for overriding. +/// Primitive types such as `Double` must be used to as to allow to use `@objc` keywords in extensions for overriding. /// Such tokens are packed in a _Swift enum_ so as to gather them in one object with the suitable namespace and avoid to have just constants in nothing else /// (i.e. publicly accessible from everywhere). More optimized than _struct_. public enum DimensionRawTokens { diff --git a/OUDS/Core/Tokens/RawTokens/Sources/Declarations/ElevationRawTokens.swift b/OUDS/Core/Tokens/RawTokens/Sources/Declarations/ElevationRawTokens.swift index 2b7af58365..885be76338 100644 --- a/OUDS/Core/Tokens/RawTokens/Sources/Declarations/ElevationRawTokens.swift +++ b/OUDS/Core/Tokens/RawTokens/Sources/Declarations/ElevationRawTokens.swift @@ -17,7 +17,7 @@ /// These tokens are used to define these effects thanks to several types: the *blur*, the *X offset* and the *Y offset*, all of them being ``ElevationRawToken`` type. /// Combinations of these three values can be defined inside ``ElevationCompositeRawToken`` i.e. *composite tokens* defining a whil box shadow to use for elevation effect. /// -/// Primitive types such as ``CGFloat`` must be used to as to allow to use `@objc` keywords in extensions for overriding. +/// Primitive types such as `CGFloat` must be used to as to allow to use `@objc` keywords in extensions for overriding. /// Such tokens are packed in a _Swift enum_ so as to gather them in one object with the suitable namespace and avoid to have just constants in nothing else /// (i.e. publicly accessible from everywhere). More optimized than _struct_. public enum ElevationRawTokens { diff --git a/OUDS/Core/Tokens/RawTokens/Sources/Declarations/GridRawTokens.swift b/OUDS/Core/Tokens/RawTokens/Sources/Declarations/GridRawTokens.swift index a44ca3dc58..bc0af8903f 100644 --- a/OUDS/Core/Tokens/RawTokens/Sources/Declarations/GridRawTokens.swift +++ b/OUDS/Core/Tokens/RawTokens/Sources/Declarations/GridRawTokens.swift @@ -15,7 +15,7 @@ /// Values are defined in *GridRawTokens+Values.swift* file updated by the tokenator. /// ``GridRawTokens`` are tokens to use to define *grids* using ``GridRawToken` type. /// -/// Primitive types such as ``Int`` must be used to as to allow to use `@objc` keywords in extensions for overriding. +/// Primitive types such as `Int must be used to as to allow to use `@objc` keywords in extensions for overriding. /// Such tokens are packed in a _Swift enum_ so as to gather them in one object with the suitable namespace and avoid to have just constants in nothing else /// (i.e. publicly accessible from everywhere). More optimized than _struct_. public enum GridRawTokens { diff --git a/OUDS/Core/Tokens/RawTokens/Sources/Declarations/OpacityRawTokens.swift b/OUDS/Core/Tokens/RawTokens/Sources/Declarations/OpacityRawTokens.swift index eaeaff8665..c4a5a277e0 100644 --- a/OUDS/Core/Tokens/RawTokens/Sources/Declarations/OpacityRawTokens.swift +++ b/OUDS/Core/Tokens/RawTokens/Sources/Declarations/OpacityRawTokens.swift @@ -15,7 +15,7 @@ /// Values are defined in *OpacityRawTokens+Values.swift* file and generated by the tokenator. /// ``OpacityRawTokens`` are tokens to use to define *opacity* effects thanks to ``OpacityRawToken``. /// -/// Primitive types such as ``Double`` must be used to as to allow to use `@objc` keywords in extensions for overriding. +/// Primitive types such as `Double` must be used to as to allow to use `@objc` keywords in extensions for overriding. /// Such tokens are packed in a _Swift enum_ so as to gather them in one object with the suitable namespace and avoid to have just constants in nothing else /// (i.e. publicly accessible from everywhere). More optimized than _struct_. public enum OpacityRawTokens { diff --git a/OUDS/Core/Tokens/RawTokens/Sources/Declarations/TypographyRawTokens.swift b/OUDS/Core/Tokens/RawTokens/Sources/Declarations/TypographyRawTokens.swift index bbb802f763..465c6cb92f 100644 --- a/OUDS/Core/Tokens/RawTokens/Sources/Declarations/TypographyRawTokens.swift +++ b/OUDS/Core/Tokens/RawTokens/Sources/Declarations/TypographyRawTokens.swift @@ -22,7 +22,7 @@ /// - and the *font letter spacing* (``TypographyFontLetterSpacingRawToken``). /// Combinations of these raw tokens can be made inside ``TypographyCompositeRawToken``, which are composite tokens defining in the end a specific typography to apply. /// -/// Primitive types such as ``Int` and ``String``must be used to as to allow to use `@objc` keywords in extensions for overriding. +/// Primitive types such as `Int` and `String` must be used to as to allow to use `@objc` keywords in extensions for overriding. /// Such tokens are packed in a _Swift enum_ so as to gather them in one object with the suitable namespace and avoid to have just constants in nothing else /// (i.e. publicly accessible from everywhere). More optimized than _struct_. public enum TypographyRawTokens { diff --git a/OUDS/Core/Tokens/RawTokens/Sources/TypeAliases/BorderRawTokens+Aliases.swift b/OUDS/Core/Tokens/RawTokens/Sources/TypeAliases/BorderRawTokens+Aliases.swift index 0a78697b7c..e33c20ba68 100644 --- a/OUDS/Core/Tokens/RawTokens/Sources/TypeAliases/BorderRawTokens+Aliases.swift +++ b/OUDS/Core/Tokens/RawTokens/Sources/TypeAliases/BorderRawTokens+Aliases.swift @@ -11,16 +11,16 @@ // Software description: A SwiftUI components library with code examples for Orange Unified Design System // -/// Type alias precising ``Double`` value are used (because of multiplier factors) for a **border width raw token**, to keep grammar clean and clear with design system grammar. +/// Type alias precising `Double` value are used (because of multiplier factors) for a **border width raw token**, to keep grammar clean and clear with design system grammar. public typealias BorderWidthRawToken = Double -/// Type alias precising ``Double`` value are used (because of multiplier factors) for a **border radius raw token**, to keep grammar clean and clear with design system grammar. +/// Type alias precising `Double` value are used (because of multiplier factors) for a **border radius raw token**, to keep grammar clean and clear with design system grammar. public typealias BorderRadiusRawToken = Double -/// Type alias for ``String`` so as to help users (developers) to see that raw tokens are needed and linked to ``String` for **border style raw token**. -/// ``String`` are used here to prevent to rely on _SwiftUI_ types which are not compatible with `@objc` and are heavier than primitive types. +/// Type alias for `String` so as to help users (developers) to see that raw tokens are needed and linked to `String` for **border style raw token**. +/// `String` are used here to prevent to rely on _SwiftUI_ types which are not compatible with `@objc` and are heavier than primitive types. /// In addition, if new styles are defined in design team side (such as kind of composite styles) and need to be processed differently /// (because not available with _SwiftUI_ because are composed of several styles), -/// such ``String`` values could be processed later without any API breaks. +/// such `String` values could be processed later without any API breaks. /// Keeps grammar clean and clear with design system grammar. public typealias BorderStyleRawToken = String diff --git a/OUDS/Core/Tokens/RawTokens/Sources/TypeAliases/TypographyRawTokens+Aliases.swift b/OUDS/Core/Tokens/RawTokens/Sources/TypeAliases/TypographyRawTokens+Aliases.swift index 2558dce6cc..855a57363a 100644 --- a/OUDS/Core/Tokens/RawTokens/Sources/TypeAliases/TypographyRawTokens+Aliases.swift +++ b/OUDS/Core/Tokens/RawTokens/Sources/TypeAliases/TypographyRawTokens+Aliases.swift @@ -13,17 +13,17 @@ import Foundation -/// In the global design system tool, *font family* raw tokens are basically ``String`` values, to keep grammar clean and clear with design system grammar. +/// In the global design system tool, *font family* raw tokens are basically `String` values, to keep grammar clean and clear with design system grammar. public typealias TypographyFontFamilyRawToken = String -/// In the global design system tool, *font weight* raw tokens are basically ``Int`` values, to keep grammar clean and clear with design system grammar. +/// In the global design system tool, *font weight* raw tokens are basically `Int` values, to keep grammar clean and clear with design system grammar. public typealias TypographyFontWeightRawToken = Int -/// In the global design system tool, *font size* raw tokens are basically ``CGFloat`` values, to keep grammar clean and clear with design system grammar. +/// In the global design system tool, *font size* raw tokens are basically `CGFloat` values, to keep grammar clean and clear with design system grammar. public typealias TypographyFontSizeRawToken = CGFloat -/// In the global design system tool, *font line height* raw tokens are basically ``CGFloat`` values, to keep grammar clean and clear with design system grammar. +/// In the global design system tool, *font line height* raw tokens are basically `CGFloat` values, to keep grammar clean and clear with design system grammar. public typealias TypographyFontLineHeightRawToken = CGFloat -/// In the global design system tool, *font letter spacing* raw tokens are basically ``CGFloat` values, to keep grammar clean and clear with design system grammar. +/// In the global design system tool, *font letter spacing* raw tokens are basically `CGFloat` values, to keep grammar clean and clear with design system grammar. public typealias TypographyFontLetterSpacingRawToken = CGFloat diff --git a/OUDS/Core/Tokens/SemanticTokens/Sources/Multiples/MultipleElevationTokens.swift b/OUDS/Core/Tokens/SemanticTokens/Sources/Multiples/MultipleElevationTokens.swift index 4a55dfe4a8..fb844605e1 100644 --- a/OUDS/Core/Tokens/SemanticTokens/Sources/Multiples/MultipleElevationTokens.swift +++ b/OUDS/Core/Tokens/SemanticTokens/Sources/Multiples/MultipleElevationTokens.swift @@ -15,7 +15,7 @@ import OUDSFoundations import OUDSTokensRaw import SwiftUI -/// Semantic tokens which will wrap a combination of ``ElevationCompositeRawToken`` depending to color scheme (i.e. light mode or dark mode) +/// Semantic tokens which will wrap a combination of `ElevationCompositeRawToken` depending to color scheme (i.e. light mode or dark mode) /// Kind of composite token with multiple values, but not named "composite" because this word is already used in the design system. /// Allows to gather the multiple-value tokens from *Figma* inside one object. /// If an elevation token exists with its value depending to the color scheme, it must be packed in such ``MultipleElevationTokens` @@ -30,10 +30,14 @@ import SwiftUI /// // inside ElevationCompositeSemanticTokens protocol, /// // and defined inside OUDSTheme+ElevationCompositeSemanticTokens extension /// // ElevationCompositeSemanticToken is a typealias for MultipleElevationTokens to keep same grammar as dsign kit -/// var elevationNone: ElevationCompositeSemanticToken { ElevationCompositeSemanticToken(light: elevationBottom_0, dark: elevationBottom_1_100) } +/// var elevationNone: ElevationCompositeSemanticToken { +/// ElevationCompositeSemanticToken(light: elevationBottom_0, dark: elevationBottom_1_100) +/// } /// -/// // If the same color is used whatever the color scheme is -/// var elevationNone: ElevationCompositeSemanticToken { ElevationCompositeSemanticToken(elevationBottom_0) } +/// // If the same elevation is used whatever the color scheme is +/// var elevationNone: ElevationCompositeSemanticToken { +/// ElevationCompositeSemanticToken(elevationBottom_0) +/// } /// /// // The theme exposes both generated elevation semantic tokens and "crafted" higher level elevation semantic tokens. /// // It is recommended to use the higher level version as it is less error-prone. diff --git a/OUDS/Core/Tokens/SemanticTokens/Sources/Multiples/MultipleFontSizeTokens.swift b/OUDS/Core/Tokens/SemanticTokens/Sources/Multiples/MultipleFontSizeTokens.swift index 79ba6d9fe5..cc574f1bc7 100644 --- a/OUDS/Core/Tokens/SemanticTokens/Sources/Multiples/MultipleFontSizeTokens.swift +++ b/OUDS/Core/Tokens/SemanticTokens/Sources/Multiples/MultipleFontSizeTokens.swift @@ -16,7 +16,7 @@ import OUDSTokensRaw /// Kind of semantic tokens which will wrap a combination of ``TypographyFontSizeSemanticToken`` depending to size classes. /// Allows to gather the multiple-value tokens from Figma inside one object. -/// If a font size exists with its value depending to the size class, it must be packed in such ``MultipleFontSizeTokens`` +/// If a font size exists with its value depending to the size class, it must be packed in such ``MultipleFontSizeTokens``. /// /// ```swift /// // Assuming in Figma with have a font size semantic token fontSizeBodySmall, diff --git a/OUDS/Core/Tokens/SemanticTokens/Sources/Multiples/MultipleSizeTokens.swift b/OUDS/Core/Tokens/SemanticTokens/Sources/Multiples/MultipleSizeTokens.swift index c9c5ddac84..04b2c95ffe 100644 --- a/OUDS/Core/Tokens/SemanticTokens/Sources/Multiples/MultipleSizeTokens.swift +++ b/OUDS/Core/Tokens/SemanticTokens/Sources/Multiples/MultipleSizeTokens.swift @@ -17,7 +17,7 @@ import SwiftUICore /// Kind of semantic tokens which will wrap a combination of ``SizeSemanticToken`` depending to viewports / size classes. /// Kind of composite token with multiple values, but not named "composite" because this word is already used in the design system. /// Allows to gather the multiple-value tokens from Figma inside one object. -/// If a size token exists with its value depending to the size class, it must be packed in such ``MultipleSizeTokens` +/// If a size token exists with its value depending to the size class, it must be packed in such ``MultipleSizeTokens``. /// /// ```swift /// // Assuming in Figma with have a size semantic token sizeIconWithHeadingXLargeTall, diff --git a/OUDS/Core/Tokens/SemanticTokens/Sources/Multiples/MultipleSpaceTokens.swift b/OUDS/Core/Tokens/SemanticTokens/Sources/Multiples/MultipleSpaceTokens.swift index 8830ca3764..88b5d32b38 100644 --- a/OUDS/Core/Tokens/SemanticTokens/Sources/Multiples/MultipleSpaceTokens.swift +++ b/OUDS/Core/Tokens/SemanticTokens/Sources/Multiples/MultipleSpaceTokens.swift @@ -15,10 +15,10 @@ import Foundation import OUDSTokensRaw import SwiftUICore -/// Kind of semantic tokens which will wrap a combination of ``DimensionRawToken`` depending to size classes. +/// Kind of semantic tokens which will wrap a combination of `DimensionRawToken` depending to size classes. /// Kind of composite token with multiple values, but not named "composite" because this word is already used in the design system. /// Allows to gather the multiple-value tokens from Figma inside one object. -/// If a space token exists with its value depending to the size class, it must be packed in such ``MultipleSpaceTokens`` +/// If a space token exists with its value depending to the size class, it must be packed in such ``MultipleSpaceTokens``. /// /// ```swift /// // Assuming in Figma with have a space semantic token spaceScaledShortest, diff --git a/OUDS/Core/Tokens/SemanticTokens/Sources/Multiples/MultipleTypographyTokens.swift b/OUDS/Core/Tokens/SemanticTokens/Sources/Multiples/MultipleTypographyTokens.swift index 110be86393..693b8262f7 100644 --- a/OUDS/Core/Tokens/SemanticTokens/Sources/Multiples/MultipleTypographyTokens.swift +++ b/OUDS/Core/Tokens/SemanticTokens/Sources/Multiples/MultipleTypographyTokens.swift @@ -14,10 +14,10 @@ import OUDSTokensRaw import SwiftUICore -/// Kind of semantic tokens which will wrap a combination of ``TypographyCompositeRawToken`` depending to size classes. +/// Kind of semantic tokens which will wrap a combination of `TypographyCompositeRawToken` depending to size classes. /// Kind of composite token with multiple values, but not named "composite" because this word is already used in the design system. /// Allows to gather the multiple-value tokens from *Figma* inside one object. -/// If a typography token exists with its value depending to the size class, it must be packed in such ``MultipleTypographyTokens`` +/// If a typography token exists with its value depending to the size class, it must be packed in such ``MultipleTypographyTokens``. /// /// ```swift /// // Assuming in Figma with have a typography semantic token typeDisplayLarge, @@ -37,7 +37,7 @@ import SwiftUICore /// // It is recommended to use the higher level version as it is less error-prone. /// ``` /// -/// The case of this ``MultipleTypographyTokens`` is quite particular because in fact it contains ``TypographyCompositeRawToken`` (i.e. raw tokens) instead of semantic tokens. +/// The case of this ``MultipleTypographyTokens`` is quite particular because in fact it contains `TypographyCompositeRawToken` (i.e. raw tokens) instead of semantic tokens. /// In fact there is not "typography composite semantic tokens" defined in the *Figma* kit. /// public final class MultipleTypographyTokens: NSObject, Sendable { diff --git a/OUDS/Core/Tokens/SemanticTokens/Sources/TypeAliases/BorderSemanticTokens+Aliases.swift b/OUDS/Core/Tokens/SemanticTokens/Sources/TypeAliases/BorderSemanticTokens+Aliases.swift index 13df8e9660..35eeef37f8 100644 --- a/OUDS/Core/Tokens/SemanticTokens/Sources/TypeAliases/BorderSemanticTokens+Aliases.swift +++ b/OUDS/Core/Tokens/SemanticTokens/Sources/TypeAliases/BorderSemanticTokens+Aliases.swift @@ -13,11 +13,11 @@ import OUDSTokensRaw -/// Type alias precising ``BorderWidthRawToken`` is used as a value of this **border width semantic token**, to keep grammar clean and clear with design system grammar. +/// Type alias precising `BorderWidthRawToken` is used as a value of this **border width semantic token**, to keep grammar clean and clear with design system grammar. public typealias BorderWidthSemanticToken = BorderWidthRawToken -/// Type alias precising ``BorderRadiusRawToken`` is used as a value of this **border raw semantic token**, to keep grammar clean and clear with design system grammar. +/// Type alias precising `BorderRadiusRawToken` is used as a value of this **border raw semantic token**, to keep grammar clean and clear with design system grammar. public typealias BorderRadiusSemanticToken = BorderRadiusRawToken -/// Type alias precising ``BorderStyleRawToken` is used as a value of this **border style semantic token**, to keep grammar clean and clear with design system grammar. +/// Type alias precising `BorderStyleRawToken` is used as a value of this **border style semantic token**, to keep grammar clean and clear with design system grammar. public typealias BorderStyleSemanticToken = BorderStyleRawToken diff --git a/OUDS/Core/Tokens/SemanticTokens/Sources/TypeAliases/ElevationSemanticTokens+Aliases.swift b/OUDS/Core/Tokens/SemanticTokens/Sources/TypeAliases/ElevationSemanticTokens+Aliases.swift index 0525ad47f9..350887ab64 100644 --- a/OUDS/Core/Tokens/SemanticTokens/Sources/TypeAliases/ElevationSemanticTokens+Aliases.swift +++ b/OUDS/Core/Tokens/SemanticTokens/Sources/TypeAliases/ElevationSemanticTokens+Aliases.swift @@ -26,5 +26,5 @@ public typealias ElevationBlurSemanticToken = ElevationRawToken public typealias ElevationColorSemanticToken = ColorSemanticToken /// Basically an elevationcomposite semantic token, used mainly for box shadow, is a pair of elevation composite raw tokens used depending to the color scheme. -/// A ``MultipleElevationTokens`` contains ``ElevationCompositeRawToken`` objects for light and dark modes, which contains ``ElevationRawToken`` and ``ColorRawToken` values. +/// A ``MultipleElevationTokens`` contains `ElevationCompositeRawToken` objects for light and dark modes, which contains `ElevationRawToken` and `ColorRawToken` values. public typealias ElevationCompositeSemanticToken = MultipleElevationTokens diff --git a/OUDS/Core/Tokens/SemanticTokens/Sources/Values/BorderSemanticTokens.swift b/OUDS/Core/Tokens/SemanticTokens/Sources/Values/BorderSemanticTokens.swift index f8894bc649..961590c2ba 100644 --- a/OUDS/Core/Tokens/SemanticTokens/Sources/Values/BorderSemanticTokens.swift +++ b/OUDS/Core/Tokens/SemanticTokens/Sources/Values/BorderSemanticTokens.swift @@ -19,9 +19,9 @@ // swiftlint:disable missing_docs /// This is a group of semantic tokens for **borders**. -/// It defines all ``BorderWidthSemanticToken``, ``BorderRadiusSemanticToken`` and ``BorderStyleSemanticToken` a theme must have. +/// It defines all ``BorderWidthSemanticToken``, ``BorderRadiusSemanticToken`` and ``BorderStyleSemanticToken`` a theme must have. /// -/// In the future this file should be generated by a parser converting Figma JSON to Swift code. +/// In the future this file should be generated by a the tokenator. public protocol BorderSemanticTokens { // MARK: - Semantic token - Border - Width diff --git a/OUDS/Core/Tokens/SemanticTokens/Sources/Values/ColorMultipleSemanticTokens.swift b/OUDS/Core/Tokens/SemanticTokens/Sources/Values/ColorMultipleSemanticTokens.swift index 561ba1389d..183db17dee 100644 --- a/OUDS/Core/Tokens/SemanticTokens/Sources/Values/ColorMultipleSemanticTokens.swift +++ b/OUDS/Core/Tokens/SemanticTokens/Sources/Values/ColorMultipleSemanticTokens.swift @@ -23,7 +23,7 @@ /// This is a group of semantic tokens for **colors** but using ``MultipleColorTokens``. /// /// In fact the ``MultipleColorTokens`` class will help users (i.e. developers) to handle one semantic token for color containing values for light and dark modes. -/// Because *Figma* is not able to manage pair of values for one token, and its produced JSON does not reflect this mecanism, the *tokenator* cannot provide such ``MultipleColorTokens``. Thus the "real" color semantic tokens are declared in ``ColorSemanticTokens`` protocol and defined inside ``OUDSTheme`` (to be overridable then by subthemes). These tokens are updated by the *tokenator*. Then they are gathered and wrapped so as to be used easily thanks to this ``ColorMultipleSemanticTokens` which must be updated manually. +/// Because *Figma* is not able to manage pair of values for one token, and its produced JSON does not reflect this mecanism, the *tokenator* cannot provide such ``MultipleColorTokens``. Thus the "real" color semantic tokens are declared in ``ColorSemanticTokens`` protocol and defined inside `OUDSTheme` (to be overridable then by subthemes). These tokens are updated by the *tokenator*. Then they are gathered and wrapped so as to be used easily thanks to this ``ColorMultipleSemanticTokens`` which must be updated manually. /// /// In few words: /// diff --git a/OUDS/Core/Tokens/SemanticTokens/Sources/Values/ColorSemanticTokens.swift b/OUDS/Core/Tokens/SemanticTokens/Sources/Values/ColorSemanticTokens.swift index 680bcdd83e..442718357e 100644 --- a/OUDS/Core/Tokens/SemanticTokens/Sources/Values/ColorSemanticTokens.swift +++ b/OUDS/Core/Tokens/SemanticTokens/Sources/Values/ColorSemanticTokens.swift @@ -22,9 +22,9 @@ /// This is a group of semantic tokens for **colors**. /// It defines all ``ColorSemanticToken`` a theme must have. -/// These tokens are then gathered inside ``MultipleColorTokens`` defined in ``ColorMultipleSemanticTokens` +/// These tokens are then gathered inside ``MultipleColorTokens`` defined in ``ColorMultipleSemanticTokens``. /// -/// In the future this file should be generated by a parser converting Figma JSON to Swift code. +/// In the future this file should be generated by a the tokenator. public protocol ColorSemanticTokens { // MARK: - Light values diff --git a/OUDS/Core/Tokens/SemanticTokens/Sources/Values/DimensionSemanticTokens.swift b/OUDS/Core/Tokens/SemanticTokens/Sources/Values/DimensionSemanticTokens.swift index 9543f310f8..8a7bed2500 100644 --- a/OUDS/Core/Tokens/SemanticTokens/Sources/Values/DimensionSemanticTokens.swift +++ b/OUDS/Core/Tokens/SemanticTokens/Sources/Values/DimensionSemanticTokens.swift @@ -19,9 +19,9 @@ // swiftlint:disable missing_docs /// This is a group of semantic tokens for **dimensions**. -/// It defines all ``DimensionSemanticToken` a theme must have. +/// It defines all ``DimensionSemanticToken`` a theme must have. /// -/// In the future this file should be generated by a parser converting Figma JSON to Swift code. +/// In the future this file should be generated by a the tokenator. public protocol DimensionSemanticTokens { var dimensionNone: DimensionSemanticToken { get } diff --git a/OUDS/Core/Tokens/SemanticTokens/Sources/Values/ElevationCompositeSemanticTokens.swift b/OUDS/Core/Tokens/SemanticTokens/Sources/Values/ElevationCompositeSemanticTokens.swift index ee2df67117..d3b35757ec 100644 --- a/OUDS/Core/Tokens/SemanticTokens/Sources/Values/ElevationCompositeSemanticTokens.swift +++ b/OUDS/Core/Tokens/SemanticTokens/Sources/Values/ElevationCompositeSemanticTokens.swift @@ -20,12 +20,11 @@ /// This is a group of semantic tokens for **elevations**, but only **composite tokens**. /// There are splitted and not declared in ``ElevationSemanticTokens`` as the *tokenator* tool parsing *Figma* JSON to Swift code is not able to manage them. /// Thus we need to declare them in another file to prevent them to be erased. -/// /// It declares in fact box shadows effects. /// /// This protocol makes themes able to provide and override ``ElevationCompositeSemanticToken``. -/// ``ElevationCompositeSemanticToken`` refers to ``MultipleElevationTokens`, which contains for light and dark color schemes ``ElevationCompositeRawToken`. -/// This ``ElevationCompositeRawToken` is not managed by tokenator yet as it is composed by three properties. +/// ``ElevationCompositeSemanticToken`` refers to ``MultipleElevationTokens``, which contains for light and dark color schemes `ElevationCompositeRawToken`. +/// This `ElevationCompositeRawToken` is not managed by tokenator yet as it is composed by three properties. public protocol ElevationCompositeSemanticTokens { var elevationNone: ElevationCompositeSemanticToken { get } diff --git a/OUDS/Core/Tokens/SemanticTokens/Sources/Values/ElevationMultipleSemanticTokens.swift b/OUDS/Core/Tokens/SemanticTokens/Sources/Values/ElevationMultipleSemanticTokens.swift index b8378939dc..17425cc934 100644 --- a/OUDS/Core/Tokens/SemanticTokens/Sources/Values/ElevationMultipleSemanticTokens.swift +++ b/OUDS/Core/Tokens/SemanticTokens/Sources/Values/ElevationMultipleSemanticTokens.swift @@ -22,7 +22,7 @@ /// /// In fact the ``MultipleColorTokens`` class will help users (i.e. developers) to handle one semantic token for color containing values for light and dark modes. /// Because *Figma* is not able to manage pair of values for one token, and its produced JSON does not reflect this mecanism, the *tokenator* cannot provide such ``MultipleColorTokens``. -/// Thus the "real" elevation color semantic tokens are declared in ``ElevationSemanticTokens`` protocol and defined inside ``OUDSTheme`` (to be overridable then by subthemes). +/// Thus the "real" elevation color semantic tokens are declared in ``ElevationSemanticTokens`` protocol and defined inside `OUDSTheme` (to be overridable then by subthemes). /// These tokens are updated by the *tokenator*. /// Then they are gathered and wrapped so as to be used easily thanks to this ``ElevationMultipleSemanticTokens`` which must be updated manually. /// diff --git a/OUDS/Core/Tokens/SemanticTokens/Sources/Values/ElevationSemanticTokens.swift b/OUDS/Core/Tokens/SemanticTokens/Sources/Values/ElevationSemanticTokens.swift index 9f252ed864..02600ac2f7 100644 --- a/OUDS/Core/Tokens/SemanticTokens/Sources/Values/ElevationSemanticTokens.swift +++ b/OUDS/Core/Tokens/SemanticTokens/Sources/Values/ElevationSemanticTokens.swift @@ -20,13 +20,12 @@ // swiftlint:disable identifier_name /// This is a group of semantic tokens for **elevations**. -/// It defines all elevation semantic tokens a theme must have (``ElevationXSemanticToken``,``ElevationYSemanticToken``, +/// It defines all elevation semantic tokens a theme must have (``ElevationXSemanticToken``, ``ElevationYSemanticToken``, /// ``ElevationBlurSemanticToken`` and ``ElevationColorSemanticToken``). -/// -/// However the composite tokens (here for bow shadows) are defined in ``ElevationCompositeSemanticTokens` because the *tokenator* +/// However the composite tokens (here for box shadows) are defined in ``ElevationCompositeSemanticTokens`` because the *tokenator* /// is not able to generate them yet, and they must be defined elsewhere to not be deleted. /// -/// In the future this file should be generated by a parser converting Figma JSON to Swift code. +/// In the future this file should be generated by a the tokenator. public protocol ElevationSemanticTokens { // MARK: Semantic token - Elevation - X diff --git a/OUDS/Core/Tokens/SemanticTokens/Sources/Values/GridSemanticTokens.swift b/OUDS/Core/Tokens/SemanticTokens/Sources/Values/GridSemanticTokens.swift index dcb8e2119f..ba2f454acb 100644 --- a/OUDS/Core/Tokens/SemanticTokens/Sources/Values/GridSemanticTokens.swift +++ b/OUDS/Core/Tokens/SemanticTokens/Sources/Values/GridSemanticTokens.swift @@ -19,9 +19,9 @@ // swiftlint:disable missing_docs /// This is a group of semantic tokens for **grids**. -/// It defines all ``GridSemanticToken a theme must have. +/// It defines all `GridSemanticToken` a theme must have. /// -/// In the future this file should be generated by a parser converting Figma JSON to Swift code. +/// In the future this file should be generated by a the tokenator. public protocol GridSemanticTokens { // MARK: Semantic token - Grid - iOS Extra compact diff --git a/OUDS/Core/Tokens/SemanticTokens/Sources/Values/OpacitySemanticTokens.swift b/OUDS/Core/Tokens/SemanticTokens/Sources/Values/OpacitySemanticTokens.swift index 9cf397e233..0d2b270679 100644 --- a/OUDS/Core/Tokens/SemanticTokens/Sources/Values/OpacitySemanticTokens.swift +++ b/OUDS/Core/Tokens/SemanticTokens/Sources/Values/OpacitySemanticTokens.swift @@ -19,8 +19,9 @@ // swiftlint:disable missing_docs /// This is a group of semantic tokens for **opacity.** -/// It defines all ``OpacitySemanticToken` a theme must have. -/// In the future this file should be generated by a parser converting Figma JSON to Swift code. +/// It defines all ``OpacitySemanticToken`` a theme must have. +/// +/// In the future this file should be generated by a the tokenator. public protocol OpacitySemanticTokens { // MARK: Semantic token - Opacity diff --git a/OUDS/Core/Tokens/SemanticTokens/Sources/Values/SizeMultipleSemanticTokens.swift b/OUDS/Core/Tokens/SemanticTokens/Sources/Values/SizeMultipleSemanticTokens.swift index 4ace8d762c..d4f74a9e8d 100644 --- a/OUDS/Core/Tokens/SemanticTokens/Sources/Values/SizeMultipleSemanticTokens.swift +++ b/OUDS/Core/Tokens/SemanticTokens/Sources/Values/SizeMultipleSemanticTokens.swift @@ -20,9 +20,9 @@ /// This is a group of semantic tokens for **size** but using ``MultipleSizeTokens`` /// -/// In fact the ``MultipleSizeTokens` class will help users (i.e. developers) to handle one semantic token for size containing values for compact and regular viewports / size classes. +/// In fact the ``MultipleSizeTokens`` class will help users (i.e. developers) to handle one semantic token for size containing values for compact and regular viewports / size classes. /// Because *Figma* is not able to manage pair of values for one token, and its produced JSON does not reflect this mecanism, the *tokenator* cannot provide such ``MultipleSizeTokens``. -/// A major part the "real" size semantic tokens are declared in ``SizeSemanticTokens`` protocol and defined inside ``OUDSTheme`` (to be overridable then by subthemes), and othershere. +/// A major part the "real" size semantic tokens are declared in ``SizeSemanticTokens`` protocol and defined inside `OUDSTheme` (to be overridable then by subthemes), and othershere. /// These tokens are updated by the *tokenator*. /// Then they are gathered and wrapped so as to be used easily thanks to this ``MultipleSizeTokens`` which must be updated manually. /// diff --git a/OUDS/Core/Tokens/SemanticTokens/Sources/Values/SizeSemanticTokens.swift b/OUDS/Core/Tokens/SemanticTokens/Sources/Values/SizeSemanticTokens.swift index 612ac36087..894c1dfcc1 100644 --- a/OUDS/Core/Tokens/SemanticTokens/Sources/Values/SizeSemanticTokens.swift +++ b/OUDS/Core/Tokens/SemanticTokens/Sources/Values/SizeSemanticTokens.swift @@ -19,9 +19,9 @@ // swiftlint:disable missing_docs /// This is a group of semantic tokens for **sizing**. -/// It defines all ``SizeSemanticToken` a theme must have. +/// It defines all ``SizeSemanticToken`` a theme must have. /// -/// In the future this file should be generated by a parser converting Figma JSON to Swift code. +/// In the future this file should be generated by a the tokenator. public protocol SizeSemanticTokens { // MARK: - Semantic token - Sizing - Icon with typography diff --git a/OUDS/Core/Tokens/SemanticTokens/Sources/Values/SpaceMultipleSemanticTokens.swift b/OUDS/Core/Tokens/SemanticTokens/Sources/Values/SpaceMultipleSemanticTokens.swift index 2b068579d4..6dd5ed7213 100644 --- a/OUDS/Core/Tokens/SemanticTokens/Sources/Values/SpaceMultipleSemanticTokens.swift +++ b/OUDS/Core/Tokens/SemanticTokens/Sources/Values/SpaceMultipleSemanticTokens.swift @@ -22,8 +22,8 @@ /// /// In fact the ``MultipleSpaceTokens`` class will help users (i.e. developers) to handle one semantic token for spacing containing values for compact (mobile) or regular (tablet) size classes. /// Because *Figma* is not able to manage pair of values for one token, and its produced JSON does not reflect this mecanism, the *tokenator* cannot provide such ``MultipleSpaceTokens``. -/// Thus the "real" color semantic tokens are declared in ``SpaceSemanticTokens`` protocol and defined inside ``OUDSTheme``(to be overridable then by subthemes). -/// These tokens are updated by the *tokenator*. Then they are gathered and wrapped so as to be used easily thanks to this ``SpaceMultipleSemanticTokens` which must be updated manually. +/// Thus the "real" color semantic tokens are declared in ``SpaceSemanticTokens`` protocol and defined inside `OUDSTheme` (to be overridable then by subthemes). +/// These tokens are updated by the *tokenator*. Then they are gathered and wrapped so as to be used easily thanks to this ``SpaceMultipleSemanticTokens`` which must be updated manually. /// /// In few words: /// ```swift diff --git a/OUDS/Core/Tokens/SemanticTokens/Sources/Values/SpaceSemanticTokens.swift b/OUDS/Core/Tokens/SemanticTokens/Sources/Values/SpaceSemanticTokens.swift index 6c13df8b78..cb0d0b0007 100644 --- a/OUDS/Core/Tokens/SemanticTokens/Sources/Values/SpaceSemanticTokens.swift +++ b/OUDS/Core/Tokens/SemanticTokens/Sources/Values/SpaceSemanticTokens.swift @@ -19,9 +19,9 @@ // swiftlint:disable missing_docs /// This is a group of semantic tokens for **spacing**. -/// It defines all ``SpaceSemanticToken` a theme must have. +/// It defines all ``SpaceSemanticToken`` a theme must have. /// -/// In the future this file should be generated by a parser converting Figma JSON to Swift code. +/// In the future this file should be generated by a the tokenator. public protocol SpaceSemanticTokens { // MARK: Semantic token - Spacing - Scaled diff --git a/OUDS/Core/Tokens/SemanticTokens/Sources/Values/TypographyCompositeSemanticTokens.swift b/OUDS/Core/Tokens/SemanticTokens/Sources/Values/TypographyCompositeSemanticTokens.swift index 95b8b13ccd..b196d6831e 100644 --- a/OUDS/Core/Tokens/SemanticTokens/Sources/Values/TypographyCompositeSemanticTokens.swift +++ b/OUDS/Core/Tokens/SemanticTokens/Sources/Values/TypographyCompositeSemanticTokens.swift @@ -23,8 +23,8 @@ /// /// It defines all composite typography semantic tokens a theme must have, i.e. tokens including properties for font family, font weight, font size or line height for example. /// -/// This protocol makes themes able to provide and override ``TypographyCompositeRawToken`` gathered in ``MultipleTypographyTokens` instances -/// This ``TypographyCompositeRawToken`` is not managed by tokenator yet as it is composed by several properties. +/// This protocol makes themes able to provide and override `TypographyCompositeRawToken` gathered in ``MultipleTypographyTokens`` instances. +/// This `TypographyCompositeRawToken` is not managed by tokenator yet as it is composed by several properties. public protocol TypographyCompositeSemanticTokens { // MARK: - Semantic tokens - Typography - Composites - Display diff --git a/OUDS/Core/Tokens/SemanticTokens/Sources/Values/TypographyMultipleSemanticTokens.swift b/OUDS/Core/Tokens/SemanticTokens/Sources/Values/TypographyMultipleSemanticTokens.swift index 655db28c16..b1e5336918 100644 --- a/OUDS/Core/Tokens/SemanticTokens/Sources/Values/TypographyMultipleSemanticTokens.swift +++ b/OUDS/Core/Tokens/SemanticTokens/Sources/Values/TypographyMultipleSemanticTokens.swift @@ -25,11 +25,11 @@ /// (i.e. developers) to handle one semantic token for typography things depending to size class (wether it could be compact / mobile or regular / tablet). /// Because *Figma* is not able to manage pair of values for one token, and its produced JSON does not reflect this mecanism, the *tokenator* cannot provide /// such ``MultipleFontLetterSpacingTokens``, ``MultipleFontLineHeightTokens`` and ``MultipleFontSizeTokens`` tokens. -/// Thus the "real" letter spacing, line height and font size tokens are declared in ``TypographySemanticTokens`` protocol and defined inside ``OUDSTheme``(to be overridable then by subthemes). +/// Thus the "real" letter spacing, line height and font size tokens are declared in ``TypographySemanticTokens`` protocol and defined inside `OUDSTheme` (to be overridable then by subthemes). /// These tokens are updated by the *tokenator*. /// Then they are gathered and wrapped so as to be used easily thanks to this ``TypographyMultipleSemanticTokens`` which must be updated manually. /// -/// However the composite tokens (here the ones gathering each type of semantic token here) are defined in ``TypographyCompositeSemanticTokens` because the *tokenator* +/// However the composite tokens (here the ones gathering each type of semantic token here) are defined in ``TypographyCompositeSemanticTokens`` because the *tokenator* /// is not able to generate them yet, and they must be defined elsewhere to not be deleted. /// /// In few words: diff --git a/OUDS/Core/Tokens/SemanticTokens/Sources/Values/TypographySemanticTokens.swift b/OUDS/Core/Tokens/SemanticTokens/Sources/Values/TypographySemanticTokens.swift index 272634bfcd..f3867ea987 100644 --- a/OUDS/Core/Tokens/SemanticTokens/Sources/Values/TypographySemanticTokens.swift +++ b/OUDS/Core/Tokens/SemanticTokens/Sources/Values/TypographySemanticTokens.swift @@ -21,11 +21,10 @@ /// This is a group of semantic tokens for **typography**. /// It defines all typography semantic tokens a theme must have /// (``TypographyFontFamilySemanticToken``, ``TypographyFontWeightSemanticToken``, ``TypographyFontSizeSemanticToken``, ``TypographyFontLineHeightSemanticToken``). -/// -/// However the composite tokens (here the ones gathering each type of semantic token here) are defined in ``TypographyCompositeSemanticTokens` because the *tokenator* +/// However the composite tokens (here the ones gathering each type of semantic token here) are defined in ``TypographyCompositeSemanticTokens`` because the *tokenator* /// is not able to generate them yet, and they must be defined elsewhere to not be deleted. /// -/// In the future this file should be generated by a parser converting Figma JSON to Swift code. +/// In the future this file should be generated by a the tokenator. public protocol TypographySemanticTokens { // MARK: - Semantic token - Typography - Font - Family