Skip to content

Commit d600a88

Browse files
dreampiggydreampiggy
committed
Update the SDWebImage doc with newest jazzy
1 parent 52c086c commit d600a88

File tree

222 files changed

+7246
-429
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

222 files changed

+7246
-429
lines changed

‎SDWebImage/Categories.html‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88
<script src="js/jquery.min.js" defer></script>
99
<script src="js/jazzy.js" defer></script>
1010

11+
<script src="js/lunr.min.js" defer></script>
12+
<script src="js/typeahead.jquery.js" defer></script>
13+
<script src="js/jazzy.search.js" defer></script>
1114
</head>
1215
<body>
1316
<a name="//apple_ref/objc/Section/Categories" class="dashAnchor"></a>
@@ -16,6 +19,11 @@
1619
<div class="content-wrapper">
1720
<p><a href="index.html">SDWebImage 5.9.0 Docs</a> (82% documented)</p>
1821
<p class="header-right"><a href="https://github.com/SDWebImage/SDWebImage"><img src="img/gh.png"/>View on GitHub</a></p>
22+
<p class="header-right">
23+
<form role="search" action="search.json">
24+
<input type="text" placeholder="Search documentation" data-typeahead>
25+
</form>
26+
</p>
1927
</div>
2028
</header>
2129
<div class="content-wrapper">
@@ -1079,8 +1087,8 @@ <h4>Declaration</h4>
10791087
</section>
10801088
</section>
10811089
<section id="footer">
1082-
<p>&copy; 2020 <a class="link" href="https://github.com/SDWebImage/SDWebImage" target="_blank" rel="external">SDWebImage</a>. All rights reserved. (Last updated: 2020-08-27)</p>
1083-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
1090+
<p>&copy; 2020 <a class="link" href="https://github.com/SDWebImage/SDWebImage" target="_blank" rel="external">SDWebImage</a>. All rights reserved. (Last updated: 2020-08-31)</p>
1091+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
10841092
</section>
10851093
</article>
10861094
</div>

‎SDWebImage/Categories/NSData(ImageContentType).html‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88
<script src="../js/jquery.min.js" defer></script>
99
<script src="../js/jazzy.js" defer></script>
1010

11+
<script src="../js/lunr.min.js" defer></script>
12+
<script src="../js/typeahead.jquery.js" defer></script>
13+
<script src="../js/jazzy.search.js" defer></script>
1114
</head>
1215
<body>
1316
<a name="//apple_ref/objc/Extension/NSData(ImageContentType)" class="dashAnchor"></a>
@@ -16,6 +19,11 @@
1619
<div class="content-wrapper">
1720
<p><a href="../index.html">SDWebImage 5.9.0 Docs</a> (82% documented)</p>
1821
<p class="header-right"><a href="https://github.com/SDWebImage/SDWebImage"><img src="../img/gh.png"/>View on GitHub</a></p>
22+
<p class="header-right">
23+
<form role="search" action="../search.json">
24+
<input type="text" placeholder="Search documentation" data-typeahead>
25+
</form>
26+
</p>
1927
</div>
2028
</header>
2129
<div class="content-wrapper">
@@ -655,12 +663,16 @@
655663
<h1>NSData(ImageContentType)</h1>
656664
<div class="declaration">
657665
<div class="language">
666+
658667
<pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">NSData</span> <span class="p">(</span><span class="nl">ImageContentType</span><span class="p">)</span></code></pre>
659668

660669
</div>
661670
</div>
662671
<p>NSData category about the image content type and UTI.</p>
663672

673+
<div class="slightly-smaller">
674+
<a href="https://github.com/SDWebImage/SDWebImage/tree/5.9.0/SDWebImage/Core/NSData+ImageContentType.h#L32-L61">Show on GitHub</a>
675+
</div>
664676
</section>
665677
<section class="section task-group-section">
666678
<div class="task-group">
@@ -854,8 +866,8 @@ <h4>Return Value</h4>
854866
</section>
855867
</section>
856868
<section id="footer">
857-
<p>&copy; 2020 <a class="link" href="https://github.com/SDWebImage/SDWebImage" target="_blank" rel="external">SDWebImage</a>. All rights reserved. (Last updated: 2020-08-27)</p>
858-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
869+
<p>&copy; 2020 <a class="link" href="https://github.com/SDWebImage/SDWebImage" target="_blank" rel="external">SDWebImage</a>. All rights reserved. (Last updated: 2020-08-31)</p>
870+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
859871
</section>
860872
</article>
861873
</div>

‎SDWebImage/Categories/UIButton(WebCache).html‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88
<script src="../js/jquery.min.js" defer></script>
99
<script src="../js/jazzy.js" defer></script>
1010

11+
<script src="../js/lunr.min.js" defer></script>
12+
<script src="../js/typeahead.jquery.js" defer></script>
13+
<script src="../js/jazzy.search.js" defer></script>
1114
</head>
1215
<body>
1316
<a name="//apple_ref/objc/Extension/UIButton(WebCache)" class="dashAnchor"></a>
@@ -16,6 +19,11 @@
1619
<div class="content-wrapper">
1720
<p><a href="../index.html">SDWebImage 5.9.0 Docs</a> (82% documented)</p>
1821
<p class="header-right"><a href="https://github.com/SDWebImage/SDWebImage"><img src="../img/gh.png"/>View on GitHub</a></p>
22+
<p class="header-right">
23+
<form role="search" action="../search.json">
24+
<input type="text" placeholder="Search documentation" data-typeahead>
25+
</form>
26+
</p>
1927
</div>
2028
</header>
2129
<div class="content-wrapper">
@@ -655,12 +663,16 @@
655663
<h1>UIButton(WebCache)</h1>
656664
<div class="declaration">
657665
<div class="language">
666+
658667
<pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">UIButton</span> <span class="p">(</span><span class="nl">WebCache</span><span class="p">)</span></code></pre>
659668

660669
</div>
661670
</div>
662671
<p>Integrates SDWebImage async downloading and caching of remote images with UIButton.</p>
663672

673+
<div class="slightly-smaller">
674+
<a href="https://github.com/SDWebImage/SDWebImage/tree/5.9.0/SDWebImage/Core/UIButton+WebCache.h#L18-L385">Show on GitHub</a>
675+
</div>
664676
</section>
665677
<section class="section task-group-section">
666678
<div class="task-group">
@@ -2765,8 +2777,8 @@ <h4>Declaration</h4>
27652777
</section>
27662778
</section>
27672779
<section id="footer">
2768-
<p>&copy; 2020 <a class="link" href="https://github.com/SDWebImage/SDWebImage" target="_blank" rel="external">SDWebImage</a>. All rights reserved. (Last updated: 2020-08-27)</p>
2769-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
2780+
<p>&copy; 2020 <a class="link" href="https://github.com/SDWebImage/SDWebImage" target="_blank" rel="external">SDWebImage</a>. All rights reserved. (Last updated: 2020-08-31)</p>
2781+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
27702782
</section>
27712783
</article>
27722784
</div>

‎SDWebImage/Categories/UIImage(ExtendedCacheData).html‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88
<script src="../js/jquery.min.js" defer></script>
99
<script src="../js/jazzy.js" defer></script>
1010

11+
<script src="../js/lunr.min.js" defer></script>
12+
<script src="../js/typeahead.jquery.js" defer></script>
13+
<script src="../js/jazzy.search.js" defer></script>
1114
</head>
1215
<body>
1316
<a name="//apple_ref/objc/Extension/UIImage(ExtendedCacheData)" class="dashAnchor"></a>
@@ -16,6 +19,11 @@
1619
<div class="content-wrapper">
1720
<p><a href="../index.html">SDWebImage 5.9.0 Docs</a> (82% documented)</p>
1821
<p class="header-right"><a href="https://github.com/SDWebImage/SDWebImage"><img src="../img/gh.png"/>View on GitHub</a></p>
22+
<p class="header-right">
23+
<form role="search" action="../search.json">
24+
<input type="text" placeholder="Search documentation" data-typeahead>
25+
</form>
26+
</p>
1927
</div>
2028
</header>
2129
<div class="content-wrapper">
@@ -655,6 +663,7 @@
655663
<h1>UIImage(ExtendedCacheData)</h1>
656664
<div class="declaration">
657665
<div class="language">
666+
658667
<pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">UIImage</span> <span class="p">(</span><span class="nl">ExtendedCacheData</span><span class="p">)</span>
659668

660669
<span class="cm">/**
@@ -671,6 +680,9 @@ <h1>UIImage(ExtendedCacheData)</h1>
671680
</div>
672681
</div>
673682

683+
<div class="slightly-smaller">
684+
<a href="https://github.com/SDWebImage/SDWebImage/tree/5.9.0/SDWebImage/Core/UIImage+ExtendedCacheData.h#L13-L24">Show on GitHub</a>
685+
</div>
674686
</section>
675687
<section class="section task-group-section">
676688
<div class="task-group">
@@ -729,8 +741,8 @@ <h4>Declaration</h4>
729741
</section>
730742
</section>
731743
<section id="footer">
732-
<p>&copy; 2020 <a class="link" href="https://github.com/SDWebImage/SDWebImage" target="_blank" rel="external">SDWebImage</a>. All rights reserved. (Last updated: 2020-08-27)</p>
733-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
744+
<p>&copy; 2020 <a class="link" href="https://github.com/SDWebImage/SDWebImage" target="_blank" rel="external">SDWebImage</a>. All rights reserved. (Last updated: 2020-08-31)</p>
745+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
734746
</section>
735747
</article>
736748
</div>

‎SDWebImage/Categories/UIImage(ForceDecode).html‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88
<script src="../js/jquery.min.js" defer></script>
99
<script src="../js/jazzy.js" defer></script>
1010

11+
<script src="../js/lunr.min.js" defer></script>
12+
<script src="../js/typeahead.jquery.js" defer></script>
13+
<script src="../js/jazzy.search.js" defer></script>
1114
</head>
1215
<body>
1316
<a name="//apple_ref/objc/Extension/UIImage(ForceDecode)" class="dashAnchor"></a>
@@ -16,6 +19,11 @@
1619
<div class="content-wrapper">
1720
<p><a href="../index.html">SDWebImage 5.9.0 Docs</a> (82% documented)</p>
1821
<p class="header-right"><a href="https://github.com/SDWebImage/SDWebImage"><img src="../img/gh.png"/>View on GitHub</a></p>
22+
<p class="header-right">
23+
<form role="search" action="../search.json">
24+
<input type="text" placeholder="Search documentation" data-typeahead>
25+
</form>
26+
</p>
1927
</div>
2028
</header>
2129
<div class="content-wrapper">
@@ -655,12 +663,16 @@
655663
<h1>UIImage(ForceDecode)</h1>
656664
<div class="declaration">
657665
<div class="language">
666+
658667
<pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">UIImage</span> <span class="p">(</span><span class="nl">ForceDecode</span><span class="p">)</span></code></pre>
659668

660669
</div>
661670
</div>
662671
<p>UIImage category about force decode feature (avoid Image/IO&rsquo;s lazy decoding during rendering behavior).</p>
663672

673+
<div class="slightly-smaller">
674+
<a href="https://github.com/SDWebImage/SDWebImage/tree/5.9.0/SDWebImage/Core/UIImage+ForceDecode.h#L14-L46">Show on GitHub</a>
675+
</div>
664676
</section>
665677
<section class="section task-group-section">
666678
<div class="task-group">
@@ -894,8 +906,8 @@ <h4>Return Value</h4>
894906
</section>
895907
</section>
896908
<section id="footer">
897-
<p>&copy; 2020 <a class="link" href="https://github.com/SDWebImage/SDWebImage" target="_blank" rel="external">SDWebImage</a>. All rights reserved. (Last updated: 2020-08-27)</p>
898-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
909+
<p>&copy; 2020 <a class="link" href="https://github.com/SDWebImage/SDWebImage" target="_blank" rel="external">SDWebImage</a>. All rights reserved. (Last updated: 2020-08-31)</p>
910+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
899911
</section>
900912
</article>
901913
</div>

‎SDWebImage/Categories/UIImage(GIF).html‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88
<script src="../js/jquery.min.js" defer></script>
99
<script src="../js/jazzy.js" defer></script>
1010

11+
<script src="../js/lunr.min.js" defer></script>
12+
<script src="../js/typeahead.jquery.js" defer></script>
13+
<script src="../js/jazzy.search.js" defer></script>
1114
</head>
1215
<body>
1316
<a name="//apple_ref/objc/Extension/UIImage(GIF)" class="dashAnchor"></a>
@@ -16,6 +19,11 @@
1619
<div class="content-wrapper">
1720
<p><a href="../index.html">SDWebImage 5.9.0 Docs</a> (82% documented)</p>
1821
<p class="header-right"><a href="https://github.com/SDWebImage/SDWebImage"><img src="../img/gh.png"/>View on GitHub</a></p>
22+
<p class="header-right">
23+
<form role="search" action="../search.json">
24+
<input type="text" placeholder="Search documentation" data-typeahead>
25+
</form>
26+
</p>
1927
</div>
2028
</header>
2129
<div class="content-wrapper">
@@ -655,12 +663,16 @@
655663
<h1>UIImage(GIF)</h1>
656664
<div class="declaration">
657665
<div class="language">
666+
658667
<pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">UIImage</span> <span class="p">(</span><span class="nl">GIF</span><span class="p">)</span></code></pre>
659668

660669
</div>
661670
</div>
662671
<p>This category is just use as a convenience method. For more detail control, use methods in <code>UIImage+MultiFormat.h</code> or directly use <code><a href="../Protocols/SDImageCoder.html">SDImageCoder</a></code>.</p>
663672

673+
<div class="slightly-smaller">
674+
<a href="https://github.com/SDWebImage/SDWebImage/tree/5.9.0/SDWebImage/Core/UIImage+GIF.h#L15-L26">Show on GitHub</a>
675+
</div>
664676
</section>
665677
<section class="section task-group-section">
666678
<div class="task-group">
@@ -729,8 +741,8 @@ <h4>Return Value</h4>
729741
</section>
730742
</section>
731743
<section id="footer">
732-
<p>&copy; 2020 <a class="link" href="https://github.com/SDWebImage/SDWebImage" target="_blank" rel="external">SDWebImage</a>. All rights reserved. (Last updated: 2020-08-27)</p>
733-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
744+
<p>&copy; 2020 <a class="link" href="https://github.com/SDWebImage/SDWebImage" target="_blank" rel="external">SDWebImage</a>. All rights reserved. (Last updated: 2020-08-31)</p>
745+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
734746
</section>
735747
</article>
736748
</div>

‎SDWebImage/Categories/UIImage(MemoryCacheCost).html‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88
<script src="../js/jquery.min.js" defer></script>
99
<script src="../js/jazzy.js" defer></script>
1010

11+
<script src="../js/lunr.min.js" defer></script>
12+
<script src="../js/typeahead.jquery.js" defer></script>
13+
<script src="../js/jazzy.search.js" defer></script>
1114
</head>
1215
<body>
1316
<a name="//apple_ref/objc/Extension/UIImage(MemoryCacheCost)" class="dashAnchor"></a>
@@ -16,6 +19,11 @@
1619
<div class="content-wrapper">
1720
<p><a href="../index.html">SDWebImage 5.9.0 Docs</a> (82% documented)</p>
1821
<p class="header-right"><a href="https://github.com/SDWebImage/SDWebImage"><img src="../img/gh.png"/>View on GitHub</a></p>
22+
<p class="header-right">
23+
<form role="search" action="../search.json">
24+
<input type="text" placeholder="Search documentation" data-typeahead>
25+
</form>
26+
</p>
1927
</div>
2028
</header>
2129
<div class="content-wrapper">
@@ -655,12 +663,16 @@
655663
<h1>UIImage(MemoryCacheCost)</h1>
656664
<div class="declaration">
657665
<div class="language">
666+
658667
<pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">UIImage</span> <span class="p">(</span><span class="nl">MemoryCacheCost</span><span class="p">)</span></code></pre>
659668

660669
</div>
661670
</div>
662671
<p>UIImage category for memory cache cost.</p>
663672

673+
<div class="slightly-smaller">
674+
<a href="https://github.com/SDWebImage/SDWebImage/tree/5.9.0/SDWebImage/Core/UIImage+MemoryCacheCost.h#L14-L27">Show on GitHub</a>
675+
</div>
664676
</section>
665677
<section class="section task-group-section">
666678
<div class="task-group">
@@ -718,8 +730,8 @@ <h4>Declaration</h4>
718730
</section>
719731
</section>
720732
<section id="footer">
721-
<p>&copy; 2020 <a class="link" href="https://github.com/SDWebImage/SDWebImage" target="_blank" rel="external">SDWebImage</a>. All rights reserved. (Last updated: 2020-08-27)</p>
722-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
733+
<p>&copy; 2020 <a class="link" href="https://github.com/SDWebImage/SDWebImage" target="_blank" rel="external">SDWebImage</a>. All rights reserved. (Last updated: 2020-08-31)</p>
734+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
723735
</section>
724736
</article>
725737
</div>

0 commit comments

Comments
 (0)