Update documentation for using view extension

onevcat · Mar 20, 2024 · f13c878 · f13c878
1 parent d7505c6
commit f13c878
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 13 deletions.
diff --git a/Sources/Documentation.docc/Documentation.md b/Sources/Documentation.docc/Documentation.md
@@ -39,9 +39,9 @@ downloading again.
 
 ### Loading Images in Simple Way
 
-- <doc:UsingViewExtensions>
-- ``KingfisherManager``
+- ``KingfisherCompatible``
 - ``KingfisherWrapper``
+- ``KingfisherManager``
 - ``Source``
 
 ### Loading Options

diff --git a/Sources/Documentation.docc/UsingViewExtensions.md b/Sources/Documentation.docc/UsingViewExtensions.md
diff --git a/Sources/General/Kingfisher.swift b/Sources/General/Kingfisher.swift
@@ -64,6 +64,18 @@ public struct KingfisherWrapper<Base> {
 
 /// Represents an object type that is compatible with Kingfisher. You can use ``kf`` property to get a
 /// value in the namespace of Kingfisher.
+///
+/// In Kingfisher, most of related classes that contains an image (such as `UIImage`, `UIButton`, `NSImageView` and
+/// more) conform to this protocol, and provides the helper methods for setting an image easily. You can access the `kf`
+/// property and call its `setImage` method with a certain URL:
+///
+/// ```swift
+/// let imageView: UIImageView
+/// let url = URL(string: "https://example.com/image.jpg")
+/// imageView.kf.setImage(with: url)
+/// ```
+///
+/// For more about basic usage of Kingfisher, check the <doc:CommonTasks> documentation.
 public protocol KingfisherCompatible: AnyObject { }
 
 /// Represents a value type that is compatible with Kingfisher. You can use ``kf`` property to get a