docs: clean comments (#279)

Signed-off-by: Pierre-Yves Lapersonne <[email protected]>

OUDS/Core/OUDS/Sources/OUDSTheme/OUDSTheme+SemanticTokens/OUDSTheme+BorderSemanticTokens.swift

@@ -16,7 +16,7 @@ import OUDSTokensRaw
 import OUDSTokensSemantic
 
 // ଘ( ･ω･)_/ﾟ･:*:･｡☆
-// [File generated by with the tokenator]
+// [File generated by the tokenator since at least 21/11/2024]
 
 extension OUDSTheme: BorderSemanticTokens {
     @objc open var borderRadiusDefault: BorderRadiusSemanticToken { BorderRawTokens.borderRadius0 }

OUDS/Core/OUDS/Sources/OUDSTheme/OUDSTheme+SemanticTokens/OUDSTheme+ColorSemanticTokens.swift

@@ -16,7 +16,7 @@ import OUDSTokensRaw
 import OUDSTokensSemantic
 
 // ଘ( ･ω･)_/ﾟ･:*:･｡☆
-// [File to generate with the tokenator]
+// [File to generate by the tokenator]
 // WARNING: Not synchronized anymore with the Figjam / Figma by developers team
 // Create an issue for update https://github.com/Orange-OpenSource/ouds-ios/issues/new?template=token_update.yml
 

OUDS/Core/OUDS/Sources/OUDSTheme/OUDSTheme+SemanticTokens/OUDSTheme+DimensionSemanticTokens.swift

@@ -16,7 +16,7 @@ import OUDSTokensRaw
 import OUDSTokensSemantic
 
 // ଘ( ･ω･)_/ﾟ･:*:･｡☆
-// [File to generate with the tokenator]
+// [File to generate by the tokenator]
 // WARNING: Not synchronized anymore with the Figjam / Figma by developers team
 // Create an issue for update https://github.com/Orange-OpenSource/ouds-ios/issues/new?template=token_update.yml
 

OUDS/Core/OUDS/Sources/OUDSTheme/OUDSTheme+SemanticTokens/OUDSTheme+ElevationCompositeSemanticTokens.swift

@@ -15,7 +15,7 @@ import Foundation
 import OUDSTokensRaw
 import OUDSTokensSemantic
 
-// [File not generated with the tokenator]
+// [File not generated by the tokenator]
 // WARNING: Not synchronized anymore with the Figjam / Figma by developers team
 // Create an issue for update https://github.com/Orange-OpenSource/ouds-ios/issues/new?template=token_update.yml
 

OUDS/Core/OUDS/Sources/OUDSTheme/OUDSTheme+SemanticTokens/OUDSTheme+ElevationSemanticTokens.swift

@@ -16,7 +16,7 @@ import OUDSTokensRaw
 import OUDSTokensSemantic
 
 // ଘ( ･ω･)_/ﾟ･:*:･｡☆
-// [File generated by with the tokenator]
+// [File generated by the tokenator since at least 21/11/2024]
 
 // swiftlint:disable identifier_name
 

OUDS/Core/OUDS/Sources/OUDSTheme/OUDSTheme+SemanticTokens/OUDSTheme+GridSemanticTokens.swift

@@ -16,7 +16,7 @@ import OUDSTokensRaw
 import OUDSTokensSemantic
 
 // ଘ( ･ω･)_/ﾟ･:*:･｡☆
-// [File to generate with the tokenator]
+// [File to generate by the tokenator]
 // WARNING: Not synchronized anymore with the Figjam / Figma by developers team
 // Create an issue for update https://github.com/Orange-OpenSource/ouds-ios/issues/new?template=token_update.yml
 

OUDS/Core/OUDS/Sources/OUDSTheme/OUDSTheme+SemanticTokens/OUDSTheme+OpacitySemanticTokens.swift

@@ -16,7 +16,7 @@ import OUDSTokensRaw
 import OUDSTokensSemantic
 
 // ଘ( ･ω･)_/ﾟ･:*:･｡☆
-// [File generated by with the tokenator]
+// [File generated by the tokenator since at least 21/11/2024]
 
 extension OUDSTheme: OpacitySemanticTokens {
     @objc open var opacityMedium: OpacitySemanticToken { OpacityRawTokens.opacity500 }

OUDS/Core/OUDS/Sources/OUDSTheme/OUDSTheme+SemanticTokens/OUDSTheme+SizeSemanticTokens.swift

@@ -16,7 +16,7 @@ import OUDSTokensRaw
 import OUDSTokensSemantic
 
 // ଘ( ･ω･)_/ﾟ･:*:･｡☆
-// [File to generate with the tokenator]
+// [File to generate by the tokenator]
 // WARNING: Not synchronized anymore with the Figjam / Figma by developers team
 // Create an issue for update https://github.com/Orange-OpenSource/ouds-ios/issues/new?template=token_update.yml
 

OUDS/Core/OUDS/Sources/OUDSTheme/OUDSTheme+SemanticTokens/OUDSTheme+SpaceSemanticTokens.swift

@@ -16,7 +16,7 @@ import OUDSTokensRaw
 import OUDSTokensSemantic
 
 // ଘ( ･ω･)_/ﾟ･:*:･｡☆
-// [File to generate with the tokenator]
+// [File to generate by the tokenator]
 // WARNING: Not synchronized anymore with the Figjam / Figma by developers team
 // Create an issue for update https://github.com/Orange-OpenSource/ouds-ios/issues/new?template=token_update.yml
 

OUDS/Core/OUDS/Sources/OUDSTheme/OUDSTheme+SemanticTokens/OUDSTheme+TypographyCompositeSemanticTokens.swift

@@ -15,8 +15,7 @@ import Foundation
 import OUDSTokensRaw
 import OUDSTokensSemantic
 
-// ଘ( ･ω･)_/ﾟ･:*:･｡☆
-// [File to generate with the tokenator with Figma able to output composites and tokenatoer able to manage them]
+// [File not generated by the tokenator]
 // WARNING: Not synchronized anymore with the Figjam / Figma by developers team
 // Create an issue for update https://github.com/Orange-OpenSource/ouds-ios/issues/new?template=token_update.yml
 
@@ -26,7 +25,6 @@ import OUDSTokensSemantic
 /// These values can be overriden inside `OUDSTheme` subclasses (in extensions or not, in the same module or not) thanks to the `@objc open` combination.
 /// The aim of this extensions is to make relationships between all composite semantic tokens for typography and associated composite raw tokens.
 /// `OUDSTheme` can be seen as a kind of "abstract class" in _object oriented paradigm_.
-///
 extension OUDSTheme: TypographyCompositeSemanticTokens {
 
     // MARK: - Semantic tokens - Typography - Composites - Display

OUDS/Core/OUDS/Sources/OUDSTheme/OUDSTheme+SemanticTokens/OUDSTheme+TypographySemanticTokens.swift

@@ -16,7 +16,7 @@ import OUDSTokensRaw
 import OUDSTokensSemantic
 
 // ଘ( ･ω･)_/ﾟ･:*:･｡☆
-// [File to generate with the tokenator]
+// [File to generate by the tokenator]
 // WARNING: Not synchronized anymore with the Figjam / Figma by developers team
 // Create an issue for update https://github.com/Orange-OpenSource/ouds-ios/issues/new?template=token_update.yml
 

OUDS/Core/Themes/Inverse/Sources/InverseTheme+ColorSemanticTokens.swift

@@ -17,8 +17,9 @@ import OUDSTokensRaw
 import OUDSTokensSemantic
 
 // ଘ( ･ω･)_/ﾟ･:*:･｡☆
-// [File to generate with the tokenator]
-// WARNING: Not synchronized anymore with the Figjam
+// [File to generate by the tokenator]
+// WARNING: Not synchronized anymore with the Figjam / Figma by developers team
+// Create an issue for update https://github.com/Orange-OpenSource/ouds-ios/issues/new?template=token_update.yml
 
 // swiftlint:disable line_length
 // swiftlint:disable file_length

OUDS/Core/Themes/Orange/Sources/Declarations/OrangeBrandColorRawTokens.swift

@@ -11,11 +11,12 @@
 // Software description: A SwiftUI components library with code examples for Orange Unified Design System
 //
 
-/// This enum helps to add new raw tokens for this theme.
+/// This enum helps to add new **color raw tokens** exclusive to this theme.
 /// 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 OrangeBrandColorRawTokens {
 
     // ଘ( ･ω･)_/ﾟ･:*:･｡☆
-    // Note: So as to help the Figma-JSON-to-Swift parser the values have been added in the Values folder
+    // Note: So as to help the tokenator, the values have been added in the Values folder
+    // This trick helps also to write documentation for these tokens as the tokenator cannot generate documentation
 }

OUDS/Core/Themes/Orange/Sources/Declarations/OrangeBrandTypographyRawTokens.swift

@@ -11,11 +11,12 @@
 // Software description: A SwiftUI components library with code examples for Orange Unified Design System 
 //
 
-/// This enum helps to add new raw tokens for this theme.
+/// This enum helps to add new **typography raw tokens** exclusive to this theme.
 /// 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 OrangeBrandTypographyRawTokens {
 
     // ଘ( ･ω･)_/ﾟ･:*:･｡☆
-    // Note: So as to help the Figma-JSON-to-Swift parser the values have been added in the Values folder
+    // Note: So as to help the tokenator, the values have been added in the Values folder
+    // This trick helps also to write documentation for these tokens as the tokenator cannot generate documentation
 }

OUDS/Core/Themes/Orange/Sources/OrangeTheme+SemanticColorTokens.swift

@@ -15,7 +15,9 @@ import OUDSTokensRaw
 import OUDSTokensSemantic
 
 // ଘ( ･ω･)_/ﾟ･:*:･｡☆
-// [File to generate with the tokenator]
+// [File to generate by the tokenator]
+// WARNING: Not synchronized anymore with the Figjam / Figma by developers team
+// Create an issue for update https://github.com/Orange-OpenSource/ouds-ios/issues/new?template=token_update.yml
 
 // swiftlint:disable line_length
 

OUDS/Core/Themes/Orange/Sources/TypeAliases/OrangeBrandTypographyRawTokens+Aliases.swift

@@ -13,5 +13,5 @@
 
 import OUDSTokensRaw
 
-/// An `OrangeBrandTypographyRawToken` is just a  `TypographyFontFamilyRawToken` type
+/// An `OrangeBrandTypographyRawToken` is just a  TypographyFontFamilyRawToken` type
 public typealias OrangeBrandTypographyRawToken = TypographyFontFamilyRawToken

OUDS/Core/Themes/Orange/Sources/Values/OrangeBrandColorRawTokens+Values.swift

@@ -13,6 +13,11 @@
 
 import OUDSTokensRaw
 
+// ଘ( ･ω･)_/ﾟ･:*:･｡☆
+// [File to generate by the tokenator]
+// WARNING: Not synchronized anymore with the Figjam / Figma by developers team
+// Create an issue for update https://github.com/Orange-OpenSource/ouds-ios/issues/new?template=token_update.yml
+
 // swiftlint:disable missing_docs
 
 extension OrangeBrandColorRawTokens {

OUDS/Core/Themes/Orange/Sources/Values/OrangeBrandTypographyRawTokens+Values.swift

@@ -12,7 +12,9 @@
 //
 
 // ଘ( ･ω･)_/ﾟ･:*:･｡☆
-// [File to generate with the tokenator]
+// [File to generate by the tokenator]
+// WARNING: Not synchronized anymore with the Figjam / Figma by developers team
+// Create an issue for update https://github.com/Orange-OpenSource/ouds-ios/issues/new?template=token_update.yml
 
 // swiftlint:disable missing_docs
 

OUDS/Core/Tokens/RawTokens/Sources/Declarations/BorderRawTokens.swift

@@ -21,6 +21,6 @@
 public enum BorderRawTokens {
 
     // ଘ( ･ω･)_/ﾟ･:*:･｡☆
-    // Note: So as to help the Figma-JSON-to-Swift parser the values have been added in the Values folder
+    // Note: So as to help the tokenator, the values have been added in the Values folder
     // This trick helps also to write documentation for these tokens as the tokenator cannot generate documentation
 }

OUDS/Core/Tokens/RawTokens/Sources/Declarations/ColorRawTokens.swift

@@ -22,7 +22,7 @@
 public enum ColorRawTokens {
 
     // ଘ( ･ω･)_/ﾟ･:*:･｡☆
-    // Note: So as to help the Figma-JSON-to-Swift parser the values have been added in the Values folder
+    // Note: So as to help the tokenator, the values have been added in the Values folder
     // This trick helps also to write documentation for these tokens as the tokenator cannot generate documentation
 
     /// Applies to a color in its hexadecimal representation the given `opacity`

OUDS/Core/Tokens/RawTokens/Sources/Declarations/DimensionRawTokens.swift

@@ -21,6 +21,6 @@
 public enum DimensionRawTokens {
 
     // ଘ( ･ω･)_/ﾟ･:*:･｡☆
-    // Note: So as to help the Figma-JSON-to-Swift parser the values have been added in the Values folder
+    // Note: So as to help the tokenator, the values have been added in the Values folder
     // This trick helps also to write documentation for these tokens as the tokenator cannot generate documentation
 }

OUDS/Core/Tokens/RawTokens/Sources/Declarations/ElevationRawTokens.swift

@@ -22,6 +22,6 @@
 public enum ElevationRawTokens {
 
     // ଘ( ･ω･)_/ﾟ･:*:･｡☆
-    // Note: So as to help the Figma-JSON-to-Swift parser the values have been added in the Values folder
+    // Note: So as to help the tokenator, the values have been added in the Values folder
     // This trick helps also to write documentation for these tokens as the tokenator cannot generate documentation
 }

OUDS/Core/Tokens/RawTokens/Sources/Declarations/GridRawTokens.swift

@@ -21,6 +21,6 @@
 public enum GridRawTokens {
 
     // ଘ( ･ω･)_/ﾟ･:*:･｡☆
-    // Note: So as to help the Figma-JSON-to-Swift parser the values have been added in the Values folder
+    // Note: So as to help the tokenator, the values have been added in the Values folder
     // This trick helps also to write documentation for these tokens as the tokenator cannot generate documentation
 }

OUDS/Core/Tokens/RawTokens/Sources/Declarations/OpacityRawTokens.swift

@@ -21,6 +21,6 @@
 public enum OpacityRawTokens {
 
     // ଘ( ･ω･)_/ﾟ･:*:･｡☆
-    // Note: So as to help the Figma-JSON-to-Swift parser the values have been added in the Values folder
+    // Note: So as to help the tokenator, the values have been added in the Values folder
     // This trick helps also to write documentation for these tokens as the tokenator cannot generate documentation
 }

OUDS/Core/Tokens/RawTokens/Sources/Declarations/TypographyRawTokens.swift

@@ -22,6 +22,6 @@
 public enum TypographyRawTokens {
 
     // ଘ( ･ω･)_/ﾟ･:*:･｡☆
-    // Note: So as to help the Figma-JSON-to-Swift parser the values have been added in the Values folder
+    // Note: So as to help the tokenator, the values have been added in the Values folder
     // This trick helps also to write documentation for these tokens as the tokenator cannot generate documentation
 }

OUDS/Core/Tokens/RawTokens/Sources/Values/GridRawTokens+Values.swift

@@ -12,7 +12,7 @@
 //
 
 // ଘ( ･ω･)_/ﾟ･:*:･｡☆
-// [File to generate with the tokenator]
+// [File to generate by the tokenator]
 // WARNING: Not synchronized anymore with the Figjam / Figma by developers team
 // Create an issue for update https://github.com/Orange-OpenSource/ouds-ios/issues/new?template=token_update.yml
 

OUDS/Core/Tokens/RawTokens/Sources/Values/TypographyRawTokens+Values.swift

@@ -12,7 +12,7 @@
 //
 
 // ଘ( ･ω･)_/ﾟ･:*:･｡☆
-// [File to generate with the tokenator]
+// [File to generate by the tokenator]
 // WARNING: Not synchronized anymore with the Figjam / Figma by developers team
 
 // swiftlint:disable missing_docs