Skip to content

Commit 27c3f9a

Browse files
committed
docs: fix some warnings whle documentation generation (#293)
Signed-off-by: Pierre-Yves Lapersonne <[email protected]>
1 parent 6d24653 commit 27c3f9a

File tree

7 files changed

+14
-13
lines changed

7 files changed

+14
-13
lines changed

CHANGELOG.md

+4
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
66

77
## [Unreleased](https://github.com/Orange-OpenSource/ouds-ios/compare/0.6.0...develop)
88

9+
### Fixed
10+
11+
- [Library] Warning issues for DocC catalogs ([#293](https://github.com/Orange-OpenSource/ouds-ios/issues/293))
12+
913
## [0.6.0](https://github.com/Orange-OpenSource/ouds-ios/compare/0.5.0...0.6.0) - 2024-11-15
1014

1115
### Added

OUDS/Core/OUDS/Sources/OUDSUserInterfaceSizeClass.swift

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ extension EnvironmentValues {
3232
///
3333
/// You receive a ``OUDSUserInterfaceSizeClass`` value when you read this environment value.
3434
/// The value tells you about the amount of horizontal space available to the view that reads it.
35-
/// You can read this size class like any other of the ``EnvironmentValues``, by creating a property with the ``Environment`` property wrapper:
35+
/// You can read this size class like any other of the ``EnvironmentValues``, by creating a property with the `Environment` property wrapper:
3636
///
3737
/// @Environment(\.oudsHorizontalSizeClass) private var horizontalSizeClass
3838
///
@@ -49,7 +49,7 @@ extension EnvironmentValues {
4949
///
5050
/// You receive a ``OUDSUserInterfaceSizeClass`` value when you read this environment value.
5151
/// The value tells you about the amount of vertical space available to the view that reads it.
52-
/// You can read this size class like any other of the ``EnvironmentValues``, by creating a property with the ``Environment`` property wrapper:
52+
/// You can read this size class like any other of the ``EnvironmentValues``, by creating a property with the `Environment` property wrapper:
5353
///
5454
/// @Environment(\.oudsVerticalSizeClass) private var verticalSizeClass
5555
///

OUDS/Core/OUDS/Sources/_OUDS.docc/Components.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Components
22

3-
_Components_ are defined in the [OUDSComponents](https://ios.unified-design-system.orange.com/documentation/oudstokenscomponent/) target and can be integrated in applications.
3+
_Components_ are defined in the `OUDSComponents` target and can be integrated in applications.
44

55
**More details coming soon.**
66

@@ -20,3 +20,5 @@ Of course you must use in your root view the <doc:/OUDS/OUDSThemeableView> with
2020

2121
}
2222
```
23+
24+
You can get more details about _Components_ with the [OUDSComponents documentation](https://ios.unified-design-system.orange.com/documentation/oudstokenscomponent/).

OUDS/Core/Tokens/ComponentTokens/Sources/_OUDSTokensComponent.docc/OUDSTokensComponent.md

-3
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,3 @@ We don't have any *component token* implemented yet.
1414
## Topics
1515

1616
### Group
17-
18-
- ``FormsTextInputComponentTokens``
19-

OUDS/Core/Tokens/SemanticTokens/Sources/Multiples/MultipleColorTokens.swift

+2-2
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ public final class MultipleColorTokens: NSObject, Sendable {
7878
/// Returns the right color according to the `colorScheme`.
7979
/// - Parameter colorScheme: The color scheme
8080
/// - Returns: The right color raw token
81-
public func color(for colorSheme: ColorScheme) -> Color {
82-
(colorSheme == .light ? light : dark).color
81+
public func color(for colorScheme: ColorScheme) -> Color {
82+
(colorScheme == .light ? light : dark).color
8383
}
8484
}

OUDS/Core/Tokens/SemanticTokens/Sources/Multiples/MultipleElevationTokens.swift

+2-2
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ public final class MultipleElevationTokens: NSObject, Sendable {
5555
/// Returns the right elevation according to the `colorScheme`.
5656
/// - Parameter colorScheme: The color scheme
5757
/// - Returns: The right elevation raw token
58-
public func elevation(for colorSheme: ColorScheme) -> ElevationCompositeRawToken {
59-
(colorSheme == .light ? light : dark)
58+
public func elevation(for colorScheme: ColorScheme) -> ElevationCompositeRawToken {
59+
(colorScheme == .light ? light : dark)
6060
}
6161
}

OUDS/Foundations/Sources/Extensions/String+SwiftUI.swift

+1-3
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,7 @@ extension String {
2626

2727
/// Forges the font name which is expected for the given weight.
2828
/// Beware, the function does not check if the font exists.
29-
/// - Parameters:
30-
/// - name: The font family name (e.g. "Menlo")
31-
/// - weight: The weight to apply (e.g. "bold", "italic")
29+
/// - Parameter weight: The weight to apply (e.g. "bold", "italic")
3230
/// - Returns String: The full name of the font to use (e.g. "Menlo-Bold" or "Menlo-Italic")
3331
public func compose(withFont weight: String) -> String {
3432
guard !self.isEmpty else {

0 commit comments

Comments
 (0)