Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[#293] Remove some warnings while documentation generation #294

Merged
merged 1 commit into from
Nov 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

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

### Fixed

- [Library] Warning issues for DocC catalogs ([#293](https://github.com/Orange-OpenSource/ouds-ios/issues/293))

## [0.6.0](https://github.com/Orange-OpenSource/ouds-ios/compare/0.5.0...0.6.0) - 2024-11-15

### Added
Expand Down
4 changes: 2 additions & 2 deletions OUDS/Core/OUDS/Sources/OUDSUserInterfaceSizeClass.swift
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ extension EnvironmentValues {
///
/// You receive a ``OUDSUserInterfaceSizeClass`` value when you read this environment value.
/// The value tells you about the amount of horizontal space available to the view that reads it.
/// You can read this size class like any other of the ``EnvironmentValues``, by creating a property with the ``Environment`` property wrapper:
/// You can read this size class like any other of the ``EnvironmentValues``, by creating a property with the `Environment` property wrapper:
///
/// @Environment(\.oudsHorizontalSizeClass) private var horizontalSizeClass
///
Expand All @@ -49,7 +49,7 @@ extension EnvironmentValues {
///
/// You receive a ``OUDSUserInterfaceSizeClass`` value when you read this environment value.
/// The value tells you about the amount of vertical space available to the view that reads it.
/// You can read this size class like any other of the ``EnvironmentValues``, by creating a property with the ``Environment`` property wrapper:
/// You can read this size class like any other of the ``EnvironmentValues``, by creating a property with the `Environment` property wrapper:
///
/// @Environment(\.oudsVerticalSizeClass) private var verticalSizeClass
///
Expand Down
4 changes: 3 additions & 1 deletion OUDS/Core/OUDS/Sources/_OUDS.docc/Components.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Components

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

❗**More details coming soon.**❗

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

}
```

You can get more details about _Components_ with the [OUDSComponents documentation](https://ios.unified-design-system.orange.com/documentation/oudstokenscomponent/).
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,3 @@ We don't have any *component token* implemented yet.
## Topics

### Group

- ``FormsTextInputComponentTokens``

Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ public final class MultipleColorTokens: NSObject, Sendable {
/// Returns the right color according to the `colorScheme`.
/// - Parameter colorScheme: The color scheme
/// - Returns: The right color raw token
public func color(for colorSheme: ColorScheme) -> Color {
(colorSheme == .light ? light : dark).color
public func color(for colorScheme: ColorScheme) -> Color {
(colorScheme == .light ? light : dark).color
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ public final class MultipleElevationTokens: NSObject, Sendable {
/// Returns the right elevation according to the `colorScheme`.
/// - Parameter colorScheme: The color scheme
/// - Returns: The right elevation raw token
public func elevation(for colorSheme: ColorScheme) -> ElevationCompositeRawToken {
(colorSheme == .light ? light : dark)
public func elevation(for colorScheme: ColorScheme) -> ElevationCompositeRawToken {
(colorScheme == .light ? light : dark)
}
}
4 changes: 1 addition & 3 deletions OUDS/Foundations/Sources/Extensions/String+SwiftUI.swift
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,7 @@ extension String {

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