Skip to content

Commit a5ab5c3

Browse files
committed
CM-965: Comment added for 'ImageAsset'
1 parent 8d5dbe0 commit a5ab5c3

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

Sources/YCoreUI/Protocols/ImageAsset.swift

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@
99
import Foundation
1010
import UIKit
1111

12+
/// Any named image asset can be loaded from an asset catalog
13+
///
14+
/// All properties and functions have default implementations. At a minimum just have your string-based enum conform
15+
/// to `ImageAsset` (and have an asset catalog with matching assets). If your enum and assets live inside a Swift
16+
/// package, override `bundle` to return `.module`. If your assets are categorized within their asset catalog by
17+
/// a namespace, then override `namespace` to return the proper string prefix.
1218
public protocol ImageAsset: RawRepresentable where RawValue == String {
1319
/// The bundle containing the image assets for this enum (default is `.main`)
1420
static var bundle: Bundle { get }

0 commit comments

Comments
 (0)