Skip to content

Commit cdb7566

Browse files
aydenpaydenp
committed
Update docs
1 parent 2ec5306 commit cdb7566

36 files changed

+4820
-993
lines changed

‎.jazzy.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,6 @@ github_file_prefix: https://github.com/dynastic/ShortLook-API/tree/master
77
output: docs
88
clean: true
99
objc: true
10-
umbrella_header: ShortLook-API.h
10+
umbrella_header: ShortLook-API.h
11+
theme: fullwidth
12+
framework_root: .

‎ShortLook-API.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,9 @@
7575
/// Initialize a promise with the provided photo identifier.
7676
- (instancetype)initWithPhotoIdentifier:(NSString *)photoIdentifier;
7777

78+
/// Create a promise offer that will return the image at the provided URL, if needed.
79+
+ (instancetype)offerDownloadingPromiseWithPhotoIdentifier:(NSString *)photoIdentifier fromURL:(NSURL *)url;
80+
7881
/// Create a promise offer that will instantly return the provided image.
7982
+ (instancetype)offerInstantlyResolvingPromiseWithPhotoIdentifier:(NSString *)photoIdentifier image:(UIImage *)image;
8083

‎docs/Classes.html

Lines changed: 60 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -4,70 +4,96 @@
44
<title>Classes Reference</title>
55
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
66
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
7-
<meta charset='utf-8'>
7+
<meta charset="utf-8">
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>
16+
1317
<a name="//apple_ref/objc/Section/Classes" class="dashAnchor"></a>
18+
1419
<a title="Classes Reference"></a>
15-
<header>
16-
<div class="content-wrapper">
17-
<p><a href="index.html">ShortLook API Docs</a> (100% documented)</p>
18-
<p class="header-right"><a href="https://github.com/dynastic/ShortLook-API"><img src="img/gh.png"/>View on GitHub</a></p>
19-
</div>
20-
</header>
21-
<div class="content-wrapper">
22-
<p id="breadcrumbs">
23-
<a href="index.html">ShortLook API Reference</a>
24-
<img id="carat" src="img/carat.png" />
25-
Classes Reference
20+
21+
<header class="header">
22+
<p class="header-col header-col--primary">
23+
<a class="header-link" href="index.html">
24+
ShortLook API Docs
25+
</a>
26+
(100% documented)
2627
</p>
27-
</div>
28+
29+
<p class="header-col--secondary">
30+
<form role="search" action="search.json">
31+
<input type="text" placeholder="Search documentation" data-typeahead>
32+
</form>
33+
</p>
34+
35+
<p class="header-col header-col--secondary">
36+
<a class="header-link" href="https://github.com/dynastic/ShortLook-API">
37+
<img class="header-icon" src="img/gh.png"/>
38+
View on GitHub
39+
</a>
40+
</p>
41+
42+
</header>
43+
44+
<p class="breadcrumbs">
45+
<a class="breadcrumb" href="index.html">ShortLook API Reference</a>
46+
<img class="carat" src="img/carat.png" />
47+
Classes Reference
48+
</p>
49+
2850
<div class="content-wrapper">
29-
<nav class="sidebar">
51+
<nav class="navigation">
3052
<ul class="nav-groups">
3153
<li class="nav-group-name">
32-
<a href="Classes.html">Classes</a>
54+
<a class="nav-group-name-link" href="Classes.html">Classes</a>
3355
<ul class="nav-group-tasks">
3456
<li class="nav-group-task">
35-
<a href="Classes/DDAbstractNotification.html">DDAbstractNotification</a>
57+
<a class="nav-group-task-link" href="Classes/DDAbstractNotification.html">DDAbstractNotification</a>
3658
</li>
3759
<li class="nav-group-task">
38-
<a href="Classes/DDNotificationContactPhotoPromise.html">DDNotificationContactPhotoPromise</a>
60+
<a class="nav-group-task-link" href="Classes/DDNotificationContactPhotoPromise.html">DDNotificationContactPhotoPromise</a>
3961
</li>
4062
<li class="nav-group-task">
41-
<a href="Classes/DDNotificationContactPhotoPromiseOffer.html">DDNotificationContactPhotoPromiseOffer</a>
63+
<a class="nav-group-task-link" href="Classes/DDNotificationContactPhotoPromiseOffer.html">DDNotificationContactPhotoPromiseOffer</a>
4264
</li>
4365
<li class="nav-group-task">
44-
<a href="Classes/DDUserNotification.html">DDUserNotification</a>
66+
<a class="nav-group-task-link" href="Classes/DDUserNotification.html">DDUserNotification</a>
4567
</li>
4668
</ul>
4769
</li>
4870
<li class="nav-group-name">
49-
<a href="Protocols.html">Protocols</a>
71+
<a class="nav-group-name-link" href="Protocols.html">Protocols</a>
5072
<ul class="nav-group-tasks">
5173
<li class="nav-group-task">
52-
<a href="Protocols/DDNotificationContactPhotoProviding.html">DDNotificationContactPhotoProviding</a>
74+
<a class="nav-group-task-link" href="Protocols/DDNotificationContactPhotoProviding.html">DDNotificationContactPhotoProviding</a>
5375
</li>
5476
<li class="nav-group-task">
55-
<a href="Protocols/DDNotificationDisplayable.html">DDNotificationDisplayable</a>
77+
<a class="nav-group-task-link" href="Protocols/DDNotificationDisplayable.html">DDNotificationDisplayable</a>
5678
</li>
5779
</ul>
5880
</li>
5981
</ul>
6082
</nav>
6183
<article class="main-content">
62-
<section>
63-
<section class="section">
84+
85+
<section class="section">
86+
<div class="section-content">
6487
<h1>Classes</h1>
6588
<p>The following classes are available globally.</p>
6689

67-
</section>
68-
<section class="section task-group-section">
90+
</div>
91+
</section>
92+
93+
<section class="section">
94+
<div class="section-content">
6995
<div class="task-group">
70-
<ul>
96+
<ul class="item-container">
7197
<li class="item">
7298
<div>
7399
<code>
@@ -207,21 +233,22 @@ <h4>Declaration</h4>
207233
</div>
208234
</div>
209235
<div class="slightly-smaller">
210-
<a href="https://github.com/dynastic/ShortLook-API/tree/master/ShortLook-API.h#L71-L85">Show on GitHub</a>
236+
<a href="https://github.com/dynastic/ShortLook-API/tree/master/ShortLook-API.h#L71-L88">Show on GitHub</a>
211237
</div>
212238
</section>
213239
</div>
214240
</li>
215241
</ul>
216242
</div>
217-
</section>
218-
</section>
219-
<section id="footer">
220-
<p>&copy; 2018 <a class="link" href="https://www.dynastic.co/" target="_blank" rel="external">Dynastic Development</a>. All rights reserved. (Last updated: 2018-05-19)</p>
221-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
243+
</div>
222244
</section>
245+
223246
</article>
224247
</div>
248+
<section class="footer">
249+
<p>&copy; 2018 <a class="link" href="https://www.dynastic.co/" target="_blank" rel="external">Dynastic Development</a>. All rights reserved. (Last updated: 2018-05-19)</p>
250+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
251+
</section>
225252
</body>
226253
</div>
227254
</html>

‎docs/Classes/DDAbstractNotification.html

Lines changed: 59 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -4,63 +4,86 @@
44
<title>DDAbstractNotification Class Reference</title>
55
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
66
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
7-
<meta charset='utf-8'>
7+
<meta charset="utf-8">
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>
16+
1317
<a name="//apple_ref/objc/Class/DDAbstractNotification" class="dashAnchor"></a>
18+
1419
<a title="DDAbstractNotification Class Reference"></a>
15-
<header>
16-
<div class="content-wrapper">
17-
<p><a href="../index.html">ShortLook API Docs</a> (100% documented)</p>
18-
<p class="header-right"><a href="https://github.com/dynastic/ShortLook-API"><img src="../img/gh.png"/>View on GitHub</a></p>
19-
</div>
20-
</header>
21-
<div class="content-wrapper">
22-
<p id="breadcrumbs">
23-
<a href="../index.html">ShortLook API Reference</a>
24-
<img id="carat" src="../img/carat.png" />
25-
DDAbstractNotification Class Reference
20+
21+
<header class="header">
22+
<p class="header-col header-col--primary">
23+
<a class="header-link" href="../index.html">
24+
ShortLook API Docs
25+
</a>
26+
(100% documented)
2627
</p>
27-
</div>
28+
29+
<p class="header-col--secondary">
30+
<form role="search" action="../search.json">
31+
<input type="text" placeholder="Search documentation" data-typeahead>
32+
</form>
33+
</p>
34+
35+
<p class="header-col header-col--secondary">
36+
<a class="header-link" href="https://github.com/dynastic/ShortLook-API">
37+
<img class="header-icon" src="../img/gh.png"/>
38+
View on GitHub
39+
</a>
40+
</p>
41+
42+
</header>
43+
44+
<p class="breadcrumbs">
45+
<a class="breadcrumb" href="../index.html">ShortLook API Reference</a>
46+
<img class="carat" src="../img/carat.png" />
47+
DDAbstractNotification Class Reference
48+
</p>
49+
2850
<div class="content-wrapper">
29-
<nav class="sidebar">
51+
<nav class="navigation">
3052
<ul class="nav-groups">
3153
<li class="nav-group-name">
32-
<a href="../Classes.html">Classes</a>
54+
<a class="nav-group-name-link" href="../Classes.html">Classes</a>
3355
<ul class="nav-group-tasks">
3456
<li class="nav-group-task">
35-
<a href="../Classes/DDAbstractNotification.html">DDAbstractNotification</a>
57+
<a class="nav-group-task-link" href="../Classes/DDAbstractNotification.html">DDAbstractNotification</a>
3658
</li>
3759
<li class="nav-group-task">
38-
<a href="../Classes/DDNotificationContactPhotoPromise.html">DDNotificationContactPhotoPromise</a>
60+
<a class="nav-group-task-link" href="../Classes/DDNotificationContactPhotoPromise.html">DDNotificationContactPhotoPromise</a>
3961
</li>
4062
<li class="nav-group-task">
41-
<a href="../Classes/DDNotificationContactPhotoPromiseOffer.html">DDNotificationContactPhotoPromiseOffer</a>
63+
<a class="nav-group-task-link" href="../Classes/DDNotificationContactPhotoPromiseOffer.html">DDNotificationContactPhotoPromiseOffer</a>
4264
</li>
4365
<li class="nav-group-task">
44-
<a href="../Classes/DDUserNotification.html">DDUserNotification</a>
66+
<a class="nav-group-task-link" href="../Classes/DDUserNotification.html">DDUserNotification</a>
4567
</li>
4668
</ul>
4769
</li>
4870
<li class="nav-group-name">
49-
<a href="../Protocols.html">Protocols</a>
71+
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
5072
<ul class="nav-group-tasks">
5173
<li class="nav-group-task">
52-
<a href="../Protocols/DDNotificationContactPhotoProviding.html">DDNotificationContactPhotoProviding</a>
74+
<a class="nav-group-task-link" href="../Protocols/DDNotificationContactPhotoProviding.html">DDNotificationContactPhotoProviding</a>
5375
</li>
5476
<li class="nav-group-task">
55-
<a href="../Protocols/DDNotificationDisplayable.html">DDNotificationDisplayable</a>
77+
<a class="nav-group-task-link" href="../Protocols/DDNotificationDisplayable.html">DDNotificationDisplayable</a>
5678
</li>
5779
</ul>
5880
</li>
5981
</ul>
6082
</nav>
6183
<article class="main-content">
62-
<section>
63-
<section class="section">
84+
85+
<section class="section">
86+
<div class="section-content">
6487
<h1>DDAbstractNotification</h1>
6588
<div class="declaration">
6689
<div class="language">
@@ -70,10 +93,13 @@ <h1>DDAbstractNotification</h1>
7093
</div>
7194
<p>A ShortLook-displayable notification representing an abstract notification.</p>
7295

73-
</section>
74-
<section class="section task-group-section">
96+
</div>
97+
</section>
98+
99+
<section class="section">
100+
<div class="section-content">
75101
<div class="task-group">
76-
<ul>
102+
<ul class="item-container">
77103
<li class="item">
78104
<div>
79105
<code>
@@ -181,14 +207,15 @@ <h4>Declaration</h4>
181207
</li>
182208
</ul>
183209
</div>
184-
</section>
185-
</section>
186-
<section id="footer">
187-
<p>&copy; 2018 <a class="link" href="https://www.dynastic.co/" target="_blank" rel="external">Dynastic Development</a>. All rights reserved. (Last updated: 2018-05-19)</p>
188-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
210+
</div>
189211
</section>
212+
190213
</article>
191214
</div>
215+
<section class="footer">
216+
<p>&copy; 2018 <a class="link" href="https://www.dynastic.co/" target="_blank" rel="external">Dynastic Development</a>. All rights reserved. (Last updated: 2018-05-19)</p>
217+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
218+
</section>
192219
</body>
193220
</div>
194221
</html>

0 commit comments

Comments
 (0)