Skip to content

Commit 5ee9139

Browse files
committed
Updated Docs. Update scoping in extension files.
1 parent 2238ed7 commit 5ee9139

Some content is hidden

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

42 files changed

+4537
-49
lines changed

Siren.podspec

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Pod::Spec.new do |s|
22
s.name = "Siren"
3-
s.version = "1.2.3"
3+
s.version = "1.2.4"
44
s.summary = "Notify users when a new version of your iOS app is available, and prompt them with the App Store link.."
55

66
s.description = <<-DESC

Sources/SirenBundleExtension.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import Foundation
1010

1111
// MARK: - Bundle Extension for Siren
1212

13-
public extension Bundle {
13+
internal extension Bundle {
1414
class func bundleID() -> String? {
1515
return Bundle.main.bundleIdentifier
1616
}

Sources/SirenUIAlertControllerExtension.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import Foundation
1010

1111
// MARK: - UIAlertController Extension for Siren
1212

13-
public extension UIAlertController {
13+
internal extension UIAlertController {
1414
func show() {
1515
let window = UIWindow(frame: UIScreen.main.bounds)
1616
window.rootViewController = SirenViewController()

Sources/SirenViewController.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,6 @@ import Foundation
1010

1111
// MARK: - UIViewController Extension for Siren
1212

13-
class SirenViewController: UIViewController {
13+
internal class SirenViewController: UIViewController {
1414
override var preferredStatusBarStyle: UIStatusBarStyle { return UIApplication.shared.statusBarStyle }
1515
}

docs/Classes.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@
1313
<a title="Classes Reference"></a>
1414
<header>
1515
<div class="content-wrapper">
16-
<p><a href="index.html">Siren Docs</a> (100% documented)</p>
16+
<p><a href="index.html"> Docs</a> (100% documented)</p>
1717
</div>
1818
</header>
1919
<div class="content-wrapper">
2020
<p id="breadcrumbs">
21-
<a href="index.html">Siren Reference</a>
21+
<a href="index.html"> Reference</a>
2222
<img id="carat" src="img/carat.png" />
2323
Classes Reference
2424
</p>
@@ -108,7 +108,7 @@ <h4>Declaration</h4>
108108
</section>
109109
</section>
110110
<section id="footer">
111-
<p>&copy; 2017 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev and Aaron Brager</a>. All rights reserved. (Last updated: 2017-03-04)</p>
111+
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-03-18)</p>
112112
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
113113
</section>
114114
</article>

docs/Classes/Siren.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@
1414
<a title="Siren Class Reference"></a>
1515
<header>
1616
<div class="content-wrapper">
17-
<p><a href="../index.html">Siren Docs</a> (100% documented)</p>
17+
<p><a href="../index.html"> Docs</a> (100% documented)</p>
1818
</div>
1919
</header>
2020
<div class="content-wrapper">
2121
<p id="breadcrumbs">
22-
<a href="../index.html">Siren Reference</a>
22+
<a href="../index.html"> Reference</a>
2323
<img id="carat" src="../img/carat.png" />
2424
Siren Class Reference
2525
</p>
@@ -557,7 +557,7 @@ <h4>Parameters</h4>
557557
</section>
558558
</section>
559559
<section id="footer">
560-
<p>&copy; 2017 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev and Aaron Brager</a>. All rights reserved. (Last updated: 2017-03-04)</p>
560+
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-03-18)</p>
561561
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
562562
</section>
563563
</article>

docs/Enums.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@
1313
<a title="Enums Reference"></a>
1414
<header>
1515
<div class="content-wrapper">
16-
<p><a href="index.html">Siren Docs</a> (100% documented)</p>
16+
<p><a href="index.html"> Docs</a> (100% documented)</p>
1717
</div>
1818
</header>
1919
<div class="content-wrapper">
2020
<p id="breadcrumbs">
21-
<a href="index.html">Siren Reference</a>
21+
<a href="index.html"> Reference</a>
2222
<img id="carat" src="img/carat.png" />
2323
Enums Reference
2424
</p>
@@ -167,7 +167,7 @@ <h4>Declaration</h4>
167167
</section>
168168
</section>
169169
<section id="footer">
170-
<p>&copy; 2017 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev and Aaron Brager</a>. All rights reserved. (Last updated: 2017-03-04)</p>
170+
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-03-18)</p>
171171
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
172172
</section>
173173
</article>

docs/Enums/SirenAlertType.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@
1414
<a title="SirenAlertType Enum Reference"></a>
1515
<header>
1616
<div class="content-wrapper">
17-
<p><a href="../index.html">Siren Docs</a> (100% documented)</p>
17+
<p><a href="../index.html"> Docs</a> (100% documented)</p>
1818
</div>
1919
</header>
2020
<div class="content-wrapper">
2121
<p id="breadcrumbs">
22-
<a href="../index.html">Siren Reference</a>
22+
<a href="../index.html"> Reference</a>
2323
<img id="carat" src="../img/carat.png" />
2424
SirenAlertType Enum Reference
2525
</p>
@@ -200,7 +200,7 @@ <h4>Declaration</h4>
200200
</section>
201201
</section>
202202
<section id="footer">
203-
<p>&copy; 2017 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev and Aaron Brager</a>. All rights reserved. (Last updated: 2017-03-04)</p>
203+
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-03-18)</p>
204204
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
205205
</section>
206206
</article>

docs/Enums/SirenLanguageType.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@
1414
<a title="SirenLanguageType Enum Reference"></a>
1515
<header>
1616
<div class="content-wrapper">
17-
<p><a href="../index.html">Siren Docs</a> (100% documented)</p>
17+
<p><a href="../index.html"> Docs</a> (100% documented)</p>
1818
</div>
1919
</header>
2020
<div class="content-wrapper">
2121
<p id="breadcrumbs">
22-
<a href="../index.html">Siren Reference</a>
22+
<a href="../index.html"> Reference</a>
2323
<img id="carat" src="../img/carat.png" />
2424
SirenLanguageType Enum Reference
2525
</p>
@@ -1195,7 +1195,7 @@ <h4>Declaration</h4>
11951195
</section>
11961196
</section>
11971197
<section id="footer">
1198-
<p>&copy; 2017 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev and Aaron Brager</a>. All rights reserved. (Last updated: 2017-03-04)</p>
1198+
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-03-18)</p>
11991199
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
12001200
</section>
12011201
</article>

docs/Enums/SirenVersionCheckType.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@
1414
<a title="SirenVersionCheckType Enum Reference"></a>
1515
<header>
1616
<div class="content-wrapper">
17-
<p><a href="../index.html">Siren Docs</a> (100% documented)</p>
17+
<p><a href="../index.html"> Docs</a> (100% documented)</p>
1818
</div>
1919
</header>
2020
<div class="content-wrapper">
2121
<p id="breadcrumbs">
22-
<a href="../index.html">Siren Reference</a>
22+
<a href="../index.html"> Reference</a>
2323
<img id="carat" src="../img/carat.png" />
2424
SirenVersionCheckType Enum Reference
2525
</p>
@@ -169,7 +169,7 @@ <h4>Declaration</h4>
169169
</section>
170170
</section>
171171
<section id="footer">
172-
<p>&copy; 2017 <a class="link" href="https://github.com/ArtSabintsev/Siren" target="_blank" rel="external">Arthur Ariel Sabintsev and Aaron Brager</a>. All rights reserved. (Last updated: 2017-03-04)</p>
172+
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-03-18)</p>
173173
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
174174
</section>
175175
</article>

docs/Extensions.html

+152
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<title>Extensions Reference</title>
5+
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
6+
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
7+
<meta charset='utf-8'>
8+
<script src="js/jquery.min.js" defer></script>
9+
<script src="js/jazzy.js" defer></script>
10+
11+
</head>
12+
<body>
13+
<a title="Extensions Reference"></a>
14+
<header>
15+
<div class="content-wrapper">
16+
<p><a href="index.html"> Docs</a> (100% documented)</p>
17+
</div>
18+
</header>
19+
<div class="content-wrapper">
20+
<p id="breadcrumbs">
21+
<a href="index.html"> Reference</a>
22+
<img id="carat" src="img/carat.png" />
23+
Extensions Reference
24+
</p>
25+
</div>
26+
<div class="content-wrapper">
27+
<nav class="sidebar">
28+
<ul class="nav-groups">
29+
<li class="nav-group-name">
30+
<a href="Classes.html">Classes</a>
31+
<ul class="nav-group-tasks">
32+
<li class="nav-group-task">
33+
<a href="Classes/Siren.html">Siren</a>
34+
</li>
35+
</ul>
36+
</li>
37+
<li class="nav-group-name">
38+
<a href="Enums.html">Enums</a>
39+
<ul class="nav-group-tasks">
40+
<li class="nav-group-task">
41+
<a href="Enums/SirenAlertType.html">SirenAlertType</a>
42+
</li>
43+
<li class="nav-group-task">
44+
<a href="Enums/SirenLanguageType.html">SirenLanguageType</a>
45+
</li>
46+
<li class="nav-group-task">
47+
<a href="Enums/SirenVersionCheckType.html">SirenVersionCheckType</a>
48+
</li>
49+
</ul>
50+
</li>
51+
<li class="nav-group-name">
52+
<a href="Extensions.html">Extensions</a>
53+
<ul class="nav-group-tasks">
54+
<li class="nav-group-task">
55+
<a href="Extensions/Bundle.html">Bundle</a>
56+
</li>
57+
<li class="nav-group-task">
58+
<a href="Extensions/UIAlertController.html">UIAlertController</a>
59+
</li>
60+
</ul>
61+
</li>
62+
<li class="nav-group-name">
63+
<a href="Protocols.html">Protocols</a>
64+
<ul class="nav-group-tasks">
65+
<li class="nav-group-task">
66+
<a href="Protocols/SirenDelegate.html">SirenDelegate</a>
67+
</li>
68+
</ul>
69+
</li>
70+
</ul>
71+
</nav>
72+
<article class="main-content">
73+
<section>
74+
<section class="section">
75+
<h1>Extensions</h1>
76+
<p>The following extensions are available globally.</p>
77+
78+
</section>
79+
<section class="section task-group-section">
80+
<div class="task-group">
81+
<div class="task-name-container">
82+
<a name="/Bundle%20Extension%20for%20Siren"></a>
83+
<a name="//apple_ref/swift/Section/Bundle Extension for Siren" class="dashAnchor"></a>
84+
<a href="#/Bundle%20Extension%20for%20Siren">
85+
<h3 class="section-name">Bundle Extension for Siren</h3>
86+
</a>
87+
</div>
88+
<ul>
89+
<li class="item">
90+
<div>
91+
<code>
92+
<a name="/c:objc(cs)NSBundle"></a>
93+
<a name="//apple_ref/swift/Extension/Bundle" class="dashAnchor"></a>
94+
<a class="token" href="#/c:objc(cs)NSBundle">Bundle</a>
95+
</code>
96+
</div>
97+
<div class="height-container">
98+
<div class="pointer-container"></div>
99+
<section class="section">
100+
<div class="pointer"></div>
101+
<div class="abstract">
102+
<p>Undocumented</p>
103+
104+
<a href="Extensions/Bundle.html" class="slightly-smaller">See more</a>
105+
</div>
106+
</section>
107+
</div>
108+
</li>
109+
</ul>
110+
</div>
111+
<div class="task-group">
112+
<div class="task-name-container">
113+
<a name="/UIAlertController%20Extension%20for%20Siren"></a>
114+
<a name="//apple_ref/swift/Section/UIAlertController Extension for Siren" class="dashAnchor"></a>
115+
<a href="#/UIAlertController%20Extension%20for%20Siren">
116+
<h3 class="section-name">UIAlertController Extension for Siren</h3>
117+
</a>
118+
</div>
119+
<ul>
120+
<li class="item">
121+
<div>
122+
<code>
123+
<a name="/c:objc(cs)UIAlertController"></a>
124+
<a name="//apple_ref/swift/Extension/UIAlertController" class="dashAnchor"></a>
125+
<a class="token" href="#/c:objc(cs)UIAlertController">UIAlertController</a>
126+
</code>
127+
</div>
128+
<div class="height-container">
129+
<div class="pointer-container"></div>
130+
<section class="section">
131+
<div class="pointer"></div>
132+
<div class="abstract">
133+
<p>Undocumented</p>
134+
135+
<a href="Extensions/UIAlertController.html" class="slightly-smaller">See more</a>
136+
</div>
137+
</section>
138+
</div>
139+
</li>
140+
</ul>
141+
</div>
142+
</section>
143+
</section>
144+
<section id="footer">
145+
<p>&copy; 2017 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2017-03-18)</p>
146+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
147+
</section>
148+
</article>
149+
</div>
150+
</body>
151+
</div>
152+
</html>

0 commit comments

Comments
 (0)