jazzy 0.0.15 → 0.0.16

Sign up to get free protection for your applications and to get access to all the features.
Files changed (116) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +7 -5
  3. data/Rakefile +2 -0
  4. data/bin/jazzy +1 -1
  5. data/jazzy.gemspec +1 -0
  6. data/lib/jazzy.rb +1 -0
  7. data/lib/jazzy/assets/css/highlight.css.scss +63 -0
  8. data/lib/jazzy/assets/css/jazzy.css.scss +27 -1
  9. data/lib/jazzy/assets/js/jazzy.js +8 -2
  10. data/lib/jazzy/config.rb +32 -0
  11. data/lib/jazzy/doc.mustache +15 -1
  12. data/lib/jazzy/doc_builder.rb +24 -12
  13. data/lib/jazzy/docset_builder.rb +77 -0
  14. data/lib/jazzy/docset_builder/info_plist.mustache +20 -0
  15. data/lib/jazzy/gem_version.rb +1 -1
  16. data/lib/jazzy/highlighter.rb +10 -0
  17. data/lib/jazzy/partials/task.mustache +3 -3
  18. data/lib/jazzy/source_declaration.rb +3 -3
  19. data/lib/jazzy/source_declaration/type.rb +136 -0
  20. data/lib/jazzy/source_module.rb +10 -0
  21. data/lib/jazzy/sourcekitten.rb +35 -62
  22. data/logo.sketch +0 -0
  23. data/spec/integration_spec.rb +10 -0
  24. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Info.plist +20 -0
  25. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Classes.html +267 -0
  26. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Classes/Manager.html +488 -0
  27. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Classes/Manager/init(configuration:).html +218 -0
  28. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Classes/Request.html +841 -0
  29. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Enums.html +257 -0
  30. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Enums/ParameterEncoding.html +346 -0
  31. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Extensions.html +708 -0
  32. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Extensions/Manager.html +344 -0
  33. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Extensions/Request.html +368 -0
  34. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Functions.html +1040 -0
  35. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Global Variables.html +226 -0
  36. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Manager.html +344 -0
  37. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Manager/init(configuration:).html +218 -0
  38. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/ParameterEncoding.html +346 -0
  39. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Protocols.html +275 -0
  40. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Protocols/URLRequestConvertible.html +227 -0
  41. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Protocols/URLStringConvertible.html +227 -0
  42. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Request.html +368 -0
  43. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/URLRequestConvertible.html +227 -0
  44. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/URLStringConvertible.html +227 -0
  45. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/carat.png +0 -0
  46. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/css/highlight.css +202 -0
  47. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/css/jazzy.css +708 -0
  48. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/dash.png +0 -0
  49. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/gh.png +0 -0
  50. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/highlight.css +202 -0
  51. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/img/carat.png +0 -0
  52. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/img/dash.png +0 -0
  53. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/img/gh.png +0 -0
  54. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/index.html +755 -0
  55. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/init(configuration:).html +218 -0
  56. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/jazzy.css +708 -0
  57. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/jazzy.js +21 -0
  58. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/jquery.min.js +4 -0
  59. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/js/jazzy.js +21 -0
  60. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/js/jquery.min.js +4 -0
  61. data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/docSet.dsidx.csv +81 -0
  62. data/spec/integration_specs/document_alamofire/after/docs/Classes.html +18 -7
  63. data/spec/integration_specs/document_alamofire/after/docs/Classes/Manager.html +31 -19
  64. data/spec/integration_specs/document_alamofire/after/docs/Classes/Manager/init(configuration:).html +14 -1
  65. data/spec/integration_specs/document_alamofire/after/docs/Classes/Request.html +61 -46
  66. data/spec/integration_specs/document_alamofire/after/docs/Enums.html +18 -7
  67. data/spec/integration_specs/document_alamofire/after/docs/Enums/ParameterEncoding.html +20 -4
  68. data/spec/integration_specs/document_alamofire/after/docs/Extensions.html +68 -48
  69. data/spec/integration_specs/document_alamofire/after/docs/Extensions/Manager.html +21 -7
  70. data/spec/integration_specs/document_alamofire/after/docs/Extensions/Request.html +22 -10
  71. data/spec/integration_specs/document_alamofire/after/docs/Functions.html +51 -34
  72. data/spec/integration_specs/document_alamofire/after/docs/Global Variables.html +15 -4
  73. data/spec/integration_specs/document_alamofire/after/docs/Protocols.html +20 -7
  74. data/spec/integration_specs/document_alamofire/after/docs/Protocols/URLRequestConvertible.html +16 -4
  75. data/spec/integration_specs/document_alamofire/after/docs/Protocols/URLStringConvertible.html +16 -4
  76. data/spec/integration_specs/document_alamofire/after/docs/css/highlight.css +202 -0
  77. data/spec/integration_specs/document_alamofire/after/docs/css/jazzy.css +14 -0
  78. data/spec/integration_specs/document_alamofire/after/docs/index.html +53 -42
  79. data/spec/integration_specs/document_alamofire/after/docs/js/jazzy.js +8 -2
  80. data/spec/integration_specs/misc_jazzy_features/after/docs/Classes.html +34 -22
  81. data/spec/integration_specs/misc_jazzy_features/after/docs/Classes/ImplicitlyInternalTopLevelClass.html +16 -4
  82. data/spec/integration_specs/misc_jazzy_features/after/docs/Enums.html +16 -4
  83. data/spec/integration_specs/misc_jazzy_features/after/docs/Enums/DocumentedEnum.html +14 -1
  84. data/spec/integration_specs/misc_jazzy_features/after/docs/Global Variables.html +16 -4
  85. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Info.plist +20 -0
  86. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes.html +309 -0
  87. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/ImplicitlyInternalTopLevelClass.html +143 -0
  88. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/DocumentedEnum.html +134 -0
  89. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/Enums.html +147 -0
  90. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/Enums/DocumentedEnum.html +134 -0
  91. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/Global Variables.html +146 -0
  92. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/ImplicitlyInternalTopLevelClass.html +143 -0
  93. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/carat.png +0 -0
  94. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/css/highlight.css +202 -0
  95. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/css/jazzy.css +708 -0
  96. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/dash.png +0 -0
  97. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/gh.png +0 -0
  98. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/highlight.css +202 -0
  99. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/img/carat.png +0 -0
  100. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/img/dash.png +0 -0
  101. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/img/gh.png +0 -0
  102. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/index.html +106 -0
  103. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/jazzy.css +708 -0
  104. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/jazzy.js +21 -0
  105. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/jquery.min.js +4 -0
  106. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/js/jazzy.js +21 -0
  107. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/Documents/js/jquery.min.js +4 -0
  108. data/spec/integration_specs/misc_jazzy_features/after/docs/MiscJazzyFeatures.docset/Contents/Resources/docSet.dsidx.csv +15 -0
  109. data/spec/integration_specs/misc_jazzy_features/after/docs/css/highlight.css +202 -0
  110. data/spec/integration_specs/misc_jazzy_features/after/docs/css/jazzy.css +14 -0
  111. data/spec/integration_specs/misc_jazzy_features/after/docs/index.html +12 -1
  112. data/spec/integration_specs/misc_jazzy_features/after/docs/js/jazzy.js +8 -2
  113. metadata +88 -5
  114. data/lib/jazzy/assets/css/github_syntax_highlighting.css.scss +0 -142
  115. data/spec/integration_specs/document_alamofire/after/docs/css/github_syntax_highlighting.css +0 -98
  116. data/spec/integration_specs/misc_jazzy_features/after/docs/css/github_syntax_highlighting.css +0 -98
@@ -1,10 +1,16 @@
1
1
  // On doc load, toggle the URL hash discussion if present
2
2
  $(document).ready(function() {
3
- var linkToHash = $('a[href="' + window.location.hash +'"]');
4
- linkToHash.trigger("click");
3
+ if (!window.jazzy.docset) {
4
+ var linkToHash = $('a[href="' + window.location.hash +'"]');
5
+ linkToHash.trigger("click");
6
+ }
5
7
  });
8
+
6
9
  // On x-instance-method click, toggle its discussion and animate token.marginLeft
7
10
  $(".x-instance-method").click(function() {
11
+ if (window.jazzy.docset) {
12
+ return;
13
+ }
8
14
  var link = $(this);
9
15
  var animationDuration = 300;
10
16
  var tokenOffset = "15px";
@@ -3,8 +3,19 @@
3
3
  <head>
4
4
  <title>Classes Reference</title>
5
5
  <link rel="stylesheet" type="text/css" href="css/jazzy.css" />
6
- <link rel="stylesheet" type="text/css" href="css/github_syntax_highlighting.css" />
6
+ <link rel="stylesheet" type="text/css" href="css/highlight.css" />
7
7
  <meta charset='utf-8'>
8
+ <script type="text/javascript">
9
+ window.jazzy = {'docset': false}
10
+ if (typeof window.dash != 'undefined') {
11
+ document.documentElement.className += ' dash'
12
+ window.jazzy.docset = true
13
+ }
14
+ if (navigator.userAgent.match(/xcode/i)) {
15
+ document.documentElement.className += ' xcode'
16
+ window.jazzy.docset = true
17
+ }
18
+ </script>
8
19
  <script src="js/jquery.min.js" defer></script>
9
20
  <script src="js/jazzy.js" defer></script>
10
21
  </head>
@@ -86,6 +97,7 @@
86
97
  <div class="task-name-container">
87
98
 
88
99
  <a name="/Classes"></a>
100
+ <a name="//apple_ref/swift/Section/Classes" class="dashAnchor"></a>
89
101
  <a href="#/Classes">
90
102
  <h3 class="section-name">Classes</h3>
91
103
  </a>
@@ -96,6 +108,7 @@
96
108
  <div class="task-group-term">
97
109
  <code>
98
110
  <a name="/s:C17MiscJazzyFeatures31ImplicitlyInternalTopLevelClass">
111
+ <a name="//apple_ref/swift/Class/ImplicitlyInternalTopLevelClass" class="dashAnchor"></a>
99
112
  <a class="x-instance-method Swift" href="#/s:C17MiscJazzyFeatures31ImplicitlyInternalTopLevelClass">ImplicitlyInternalTopLevelClass</a>
100
113
  </code>
101
114
  </div>
@@ -112,9 +125,8 @@
112
125
 
113
126
  <div class="Swift">
114
127
  <p class="aside-title">Swift</p>
115
- <p class="para">
116
- <code>class ImplicitlyInternalTopLevelClass</code>
117
- </p>
128
+ <pre class="highlight"><code><span class="kd">class</span> <span class="kt">ImplicitlyInternalTopLevelClass</span></code></pre>
129
+
118
130
  </div>
119
131
  </div>
120
132
  </section>
@@ -124,6 +136,7 @@
124
136
  <div class="task-group-term">
125
137
  <code>
126
138
  <a name="/s:C17MiscJazzyFeatures31ExplicitlyInternalTopLevelClass">
139
+ <a name="//apple_ref/swift/Class/ExplicitlyInternalTopLevelClass" class="dashAnchor"></a>
127
140
  <a class="x-instance-method Swift" href="#/s:C17MiscJazzyFeatures31ExplicitlyInternalTopLevelClass">ExplicitlyInternalTopLevelClass</a>
128
141
  </code>
129
142
  </div>
@@ -139,9 +152,8 @@
139
152
 
140
153
  <div class="Swift">
141
154
  <p class="aside-title">Swift</p>
142
- <p class="para">
143
- <code>internal class ExplicitlyInternalTopLevelClass</code>
144
- </p>
155
+ <pre class="highlight"><code><span class="kd">internal</span> <span class="kd">class</span> <span class="kt">ExplicitlyInternalTopLevelClass</span></code></pre>
156
+
145
157
  </div>
146
158
  </div>
147
159
  </section>
@@ -151,6 +163,7 @@
151
163
  <div class="task-group-term">
152
164
  <code>
153
165
  <a name="/s:C17MiscJazzyFeaturesP33_72F27992F5E059C6D84AD5FC86B1B76B20PrivateTopLevelClass">
166
+ <a name="//apple_ref/swift/Class/PrivateTopLevelClass" class="dashAnchor"></a>
154
167
  <a class="x-instance-method Swift" href="#/s:C17MiscJazzyFeaturesP33_72F27992F5E059C6D84AD5FC86B1B76B20PrivateTopLevelClass">PrivateTopLevelClass</a>
155
168
  </code>
156
169
  </div>
@@ -166,9 +179,8 @@
166
179
 
167
180
  <div class="Swift">
168
181
  <p class="aside-title">Swift</p>
169
- <p class="para">
170
- <code>private class PrivateTopLevelClass</code>
171
- </p>
182
+ <pre class="highlight"><code><span class="kd">private</span> <span class="kd">class</span> <span class="kt">PrivateTopLevelClass</span></code></pre>
183
+
172
184
  </div>
173
185
  </div>
174
186
  </section>
@@ -178,6 +190,7 @@
178
190
  <div class="task-group-term">
179
191
  <code>
180
192
  <a name="/s:C17MiscJazzyFeatures19PublicTopLevelClass">
193
+ <a name="//apple_ref/swift/Class/PublicTopLevelClass" class="dashAnchor"></a>
181
194
  <a class="x-instance-method Swift" href="#/s:C17MiscJazzyFeatures19PublicTopLevelClass">PublicTopLevelClass</a>
182
195
  </code>
183
196
  </div>
@@ -193,9 +206,8 @@
193
206
 
194
207
  <div class="Swift">
195
208
  <p class="aside-title">Swift</p>
196
- <p class="para">
197
- <code>public class PublicTopLevelClass</code>
198
- </p>
209
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">PublicTopLevelClass</span></code></pre>
210
+
199
211
  </div>
200
212
  </div>
201
213
  </section>
@@ -205,6 +217,7 @@
205
217
  <div class="task-group-term">
206
218
  <code>
207
219
  <a name="/s:C17MiscJazzyFeatures17ObjCTopLevelClass">
220
+ <a name="//apple_ref/swift/Class/ObjCTopLevelClass" class="dashAnchor"></a>
208
221
  <a class="x-instance-method Swift" href="#/s:C17MiscJazzyFeatures17ObjCTopLevelClass">ObjCTopLevelClass</a>
209
222
  </code>
210
223
  </div>
@@ -220,9 +233,8 @@
220
233
 
221
234
  <div class="Swift">
222
235
  <p class="aside-title">Swift</p>
223
- <p class="para">
224
- <code>@objc class ObjCTopLevelClass</code>
225
- </p>
236
+ <pre class="highlight"><code><span class="k">@objc</span> <span class="kd">class</span> <span class="kt">ObjCTopLevelClass</span></code></pre>
237
+
226
238
  </div>
227
239
  </div>
228
240
  </section>
@@ -232,6 +244,7 @@
232
244
  <div class="task-group-term">
233
245
  <code>
234
246
  <a name="/s:C17MiscJazzyFeatures20TopLevelObjCSubclass">
247
+ <a name="//apple_ref/swift/Class/TopLevelObjCSubclass" class="dashAnchor"></a>
235
248
  <a class="x-instance-method Swift" href="#/s:C17MiscJazzyFeatures20TopLevelObjCSubclass">TopLevelObjCSubclass</a>
236
249
  </code>
237
250
  </div>
@@ -247,9 +260,8 @@
247
260
 
248
261
  <div class="Swift">
249
262
  <p class="aside-title">Swift</p>
250
- <p class="para">
251
- <code>class TopLevelObjCSubclass : NSObject</code>
252
- </p>
263
+ <pre class="highlight"><code><span class="kd">class</span> <span class="kt">TopLevelObjCSubclass</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
264
+
253
265
  </div>
254
266
  </div>
255
267
  </section>
@@ -259,6 +271,7 @@
259
271
  <div class="task-group-term">
260
272
  <code>
261
273
  <a name="/s:C17MiscJazzyFeatures21TopLevelSwiftSubclass">
274
+ <a name="//apple_ref/swift/Class/TopLevelSwiftSubclass" class="dashAnchor"></a>
262
275
  <a class="x-instance-method Swift" href="#/s:C17MiscJazzyFeatures21TopLevelSwiftSubclass">TopLevelSwiftSubclass</a>
263
276
  </code>
264
277
  </div>
@@ -274,9 +287,8 @@
274
287
 
275
288
  <div class="Swift">
276
289
  <p class="aside-title">Swift</p>
277
- <p class="para">
278
- <code>class TopLevelSwiftSubclass : ImplicitlyInternalTopLevelClass</code>
279
- </p>
290
+ <pre class="highlight"><code><span class="kd">class</span> <span class="kt">TopLevelSwiftSubclass</span> <span class="p">:</span> <span class="kt">ImplicitlyInternalTopLevelClass</span></code></pre>
291
+
280
292
  </div>
281
293
  </div>
282
294
  </section>
@@ -3,12 +3,24 @@
3
3
  <head>
4
4
  <title>ImplicitlyInternalTopLevelClass Class Reference</title>
5
5
  <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
6
- <link rel="stylesheet" type="text/css" href="../css/github_syntax_highlighting.css" />
6
+ <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
7
7
  <meta charset='utf-8'>
8
+ <script type="text/javascript">
9
+ window.jazzy = {'docset': false}
10
+ if (typeof window.dash != 'undefined') {
11
+ document.documentElement.className += ' dash'
12
+ window.jazzy.docset = true
13
+ }
14
+ if (navigator.userAgent.match(/xcode/i)) {
15
+ document.documentElement.className += ' xcode'
16
+ window.jazzy.docset = true
17
+ }
18
+ </script>
8
19
  <script src="../js/jquery.min.js" defer></script>
9
20
  <script src="../js/jazzy.js" defer></script>
10
21
  </head>
11
22
  <body id="reference" class="Swift">
23
+ <a name="//apple_ref/swift/Class/ImplicitlyInternalTopLevelClass" class="dashAnchor"></a>
12
24
  <a title="ImplicitlyInternalTopLevelClass Class Reference"></a>
13
25
  <header>
14
26
  <div class="content-wrapper">
@@ -93,6 +105,7 @@
93
105
  <div class="task-group-term">
94
106
  <code>
95
107
  <a name="/s:CC17MiscJazzyFeatures31ImplicitlyInternalTopLevelClass11NestedClass">
108
+ <a name="//apple_ref/swift/Class/NestedClass" class="dashAnchor"></a>
96
109
  <a class="x-instance-method Swift" href="#/s:CC17MiscJazzyFeatures31ImplicitlyInternalTopLevelClass11NestedClass">NestedClass</a>
97
110
  </code>
98
111
  </div>
@@ -108,9 +121,8 @@
108
121
 
109
122
  <div class="Swift">
110
123
  <p class="aside-title">Swift</p>
111
- <p class="para">
112
- <code>class NestedClass</code>
113
- </p>
124
+ <pre class="highlight"><code><span class="kd">class</span> <span class="kt">NestedClass</span></code></pre>
125
+
114
126
  </div>
115
127
  </div>
116
128
  </section>
@@ -3,8 +3,19 @@
3
3
  <head>
4
4
  <title>Enums Reference</title>
5
5
  <link rel="stylesheet" type="text/css" href="css/jazzy.css" />
6
- <link rel="stylesheet" type="text/css" href="css/github_syntax_highlighting.css" />
6
+ <link rel="stylesheet" type="text/css" href="css/highlight.css" />
7
7
  <meta charset='utf-8'>
8
+ <script type="text/javascript">
9
+ window.jazzy = {'docset': false}
10
+ if (typeof window.dash != 'undefined') {
11
+ document.documentElement.className += ' dash'
12
+ window.jazzy.docset = true
13
+ }
14
+ if (navigator.userAgent.match(/xcode/i)) {
15
+ document.documentElement.className += ' xcode'
16
+ window.jazzy.docset = true
17
+ }
18
+ </script>
8
19
  <script src="js/jquery.min.js" defer></script>
9
20
  <script src="js/jazzy.js" defer></script>
10
21
  </head>
@@ -86,6 +97,7 @@
86
97
  <div class="task-name-container">
87
98
 
88
99
  <a name="/Enums"></a>
100
+ <a name="//apple_ref/swift/Section/Enums" class="dashAnchor"></a>
89
101
  <a href="#/Enums">
90
102
  <h3 class="section-name">Enums</h3>
91
103
  </a>
@@ -96,6 +108,7 @@
96
108
  <div class="task-group-term">
97
109
  <code>
98
110
  <a name="/s:O17MiscJazzyFeatures14DocumentedEnum">
111
+ <a name="//apple_ref/swift/Enum/DocumentedEnum" class="dashAnchor"></a>
99
112
  <a class="x-instance-method Swift" href="#/s:O17MiscJazzyFeatures14DocumentedEnum">DocumentedEnum</a>
100
113
  </code>
101
114
  </div>
@@ -112,9 +125,8 @@
112
125
 
113
126
  <div class="Swift">
114
127
  <p class="aside-title">Swift</p>
115
- <p class="para">
116
- <code>enum DocumentedEnum</code>
117
- </p>
128
+ <pre class="highlight"><code><span class="kd">enum</span> <span class="kt">DocumentedEnum</span></code></pre>
129
+
118
130
  </div>
119
131
  </div>
120
132
  </section>
@@ -3,12 +3,24 @@
3
3
  <head>
4
4
  <title>DocumentedEnum Enum Reference</title>
5
5
  <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
6
- <link rel="stylesheet" type="text/css" href="../css/github_syntax_highlighting.css" />
6
+ <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
7
7
  <meta charset='utf-8'>
8
+ <script type="text/javascript">
9
+ window.jazzy = {'docset': false}
10
+ if (typeof window.dash != 'undefined') {
11
+ document.documentElement.className += ' dash'
12
+ window.jazzy.docset = true
13
+ }
14
+ if (navigator.userAgent.match(/xcode/i)) {
15
+ document.documentElement.className += ' xcode'
16
+ window.jazzy.docset = true
17
+ }
18
+ </script>
8
19
  <script src="../js/jquery.min.js" defer></script>
9
20
  <script src="../js/jazzy.js" defer></script>
10
21
  </head>
11
22
  <body id="reference" class="Swift">
23
+ <a name="//apple_ref/swift/Enum/DocumentedEnum" class="dashAnchor"></a>
12
24
  <a title="DocumentedEnum Enum Reference"></a>
13
25
  <header>
14
26
  <div class="content-wrapper">
@@ -93,6 +105,7 @@
93
105
  <div class="task-group-term">
94
106
  <code>
95
107
  <a name="/s:FO17MiscJazzyFeatures14DocumentedEnum15DocumentedValueFMS0_S0_">
108
+ <a name="//apple_ref/swift/Element/DocumentedValue" class="dashAnchor"></a>
96
109
  <a class="x-instance-method Swift" href="#/s:FO17MiscJazzyFeatures14DocumentedEnum15DocumentedValueFMS0_S0_">DocumentedValue</a>
97
110
  </code>
98
111
  </div>
@@ -3,8 +3,19 @@
3
3
  <head>
4
4
  <title>Global Variables Reference</title>
5
5
  <link rel="stylesheet" type="text/css" href="css/jazzy.css" />
6
- <link rel="stylesheet" type="text/css" href="css/github_syntax_highlighting.css" />
6
+ <link rel="stylesheet" type="text/css" href="css/highlight.css" />
7
7
  <meta charset='utf-8'>
8
+ <script type="text/javascript">
9
+ window.jazzy = {'docset': false}
10
+ if (typeof window.dash != 'undefined') {
11
+ document.documentElement.className += ' dash'
12
+ window.jazzy.docset = true
13
+ }
14
+ if (navigator.userAgent.match(/xcode/i)) {
15
+ document.documentElement.className += ' xcode'
16
+ window.jazzy.docset = true
17
+ }
18
+ </script>
8
19
  <script src="js/jquery.min.js" defer></script>
9
20
  <script src="js/jazzy.js" defer></script>
10
21
  </head>
@@ -86,6 +97,7 @@
86
97
  <div class="task-name-container">
87
98
 
88
99
  <a name="/Globals"></a>
100
+ <a name="//apple_ref/swift/Section/Globals" class="dashAnchor"></a>
89
101
  <a href="#/Globals">
90
102
  <h3 class="section-name">Globals</h3>
91
103
  </a>
@@ -96,6 +108,7 @@
96
108
  <div class="task-group-term">
97
109
  <code>
98
110
  <a name="/s:v17MiscJazzyFeatures16documentedGlobalSb">
111
+ <a name="//apple_ref/swift/Global/documentedGlobal" class="dashAnchor"></a>
99
112
  <a class="x-instance-method Swift" href="#/s:v17MiscJazzyFeatures16documentedGlobalSb">documentedGlobal</a>
100
113
  </code>
101
114
  </div>
@@ -111,9 +124,8 @@
111
124
 
112
125
  <div class="Swift">
113
126
  <p class="aside-title">Swift</p>
114
- <p class="para">
115
- <code>let documentedGlobal: Bool</code>
116
- </p>
127
+ <pre class="highlight"><code><span class="k">let</span> <span class="nv">documentedGlobal</span><span class="p">:</span> <span class="kt">Bool</span></code></pre>
128
+
117
129
  </div>
118
130
  </div>
119
131
  </section>
@@ -0,0 +1,20 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
3
+ <plist version="1.0">
4
+ <dict>
5
+ <key>CFBundleIdentifier</key>
6
+ <string>com.jazzy.miscjazzyfeatures</string>
7
+ <key>CFBundleName</key>
8
+ <string>MiscJazzyFeatures</string>
9
+ <key>DocSetPlatformFamily</key>
10
+ <string>jazzy</string>
11
+ <key>isDashDocset</key>
12
+ <true/>
13
+ <key>dashIndexFilePath</key>
14
+ <string>index.html</string>
15
+ <key>isJavaScriptEnabled</key>
16
+ <true/>
17
+ <key>DashDocSetFamily</key>
18
+ <string>dashtoc</string>
19
+ </dict>
20
+ </plist>
@@ -0,0 +1,309 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <title>Classes 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 type="text/javascript">
9
+ window.jazzy = {'docset': false}
10
+ if (typeof window.dash != 'undefined') {
11
+ document.documentElement.className += ' dash'
12
+ window.jazzy.docset = true
13
+ }
14
+ if (navigator.userAgent.match(/xcode/i)) {
15
+ document.documentElement.className += ' xcode'
16
+ window.jazzy.docset = true
17
+ }
18
+ </script>
19
+ <script src="js/jquery.min.js" defer></script>
20
+ <script src="js/jazzy.js" defer></script>
21
+ </head>
22
+ <body id="reference" class="Swift">
23
+ <a title="Classes Reference"></a>
24
+ <header>
25
+ <div class="content-wrapper">
26
+ <p class="header-text"><a href="index.html">MiscJazzyFeatures Docs</a> (81% documented)</p>
27
+ <p id="header-links"><a href="https://github.com/realm/jazzy"><img id="header-icon" src="img/gh.png" height="16px" width="16px" />View on GitHub</a></p>
28
+ </div>
29
+ </header>
30
+ <section id="valence">
31
+ <div class="content-wrapper">
32
+ <p id="hierarchial_navigation">
33
+ <a href="index.html" id="design_resources_link">MiscJazzyFeatures Reference</a>
34
+ <img id="carat" src="img/carat.png" height="10px" width="6px" />
35
+ Classes Reference
36
+ </p>
37
+ </div>
38
+ </section>
39
+ <div class="content-wrapper">
40
+ <nav class="book-parts">
41
+ <ul class="nav-parts">
42
+ <li class="part-name tasks">
43
+ <a href="Classes.html">Classes</a>
44
+ <ul class="nav-chapters">
45
+ <li class="nav-chapter">
46
+ <a href="Classes/ImplicitlyInternalTopLevelClass.html">ImplicitlyInternalTopLevelClass</a>
47
+ </li>
48
+ <li class="nav-chapter">
49
+ <a href="Classes.html#/s:C17MiscJazzyFeatures31ExplicitlyInternalTopLevelClass">ExplicitlyInternalTopLevelClass</a>
50
+ </li>
51
+ <li class="nav-chapter">
52
+ <a href="Classes.html#/s:C17MiscJazzyFeaturesP33_72F27992F5E059C6D84AD5FC86B1B76B20PrivateTopLevelClass">PrivateTopLevelClass</a>
53
+ </li>
54
+ <li class="nav-chapter">
55
+ <a href="Classes.html#/s:C17MiscJazzyFeatures19PublicTopLevelClass">PublicTopLevelClass</a>
56
+ </li>
57
+ <li class="nav-chapter">
58
+ <a href="Classes.html#/s:C17MiscJazzyFeatures17ObjCTopLevelClass">ObjCTopLevelClass</a>
59
+ </li>
60
+ <li class="nav-chapter">
61
+ <a href="Classes.html#/s:C17MiscJazzyFeatures20TopLevelObjCSubclass">TopLevelObjCSubclass</a>
62
+ </li>
63
+ <li class="nav-chapter">
64
+ <a href="Classes.html#/s:C17MiscJazzyFeatures21TopLevelSwiftSubclass">TopLevelSwiftSubclass</a>
65
+ </li>
66
+ </ul>
67
+ </li>
68
+ <li class="part-name tasks">
69
+ <a href="Global Variables.html">Global Variables</a>
70
+ <ul class="nav-chapters">
71
+ <li class="nav-chapter">
72
+ <a href="Global Variables.html#/s:v17MiscJazzyFeatures16documentedGlobalSb">documentedGlobal</a>
73
+ </li>
74
+ </ul>
75
+ </li>
76
+ <li class="part-name tasks">
77
+ <a href="Enums.html">Enums</a>
78
+ <ul class="nav-chapters">
79
+ <li class="nav-chapter">
80
+ <a href="Enums/DocumentedEnum.html">DocumentedEnum</a>
81
+ </li>
82
+ </ul>
83
+ </li>
84
+ </ul>
85
+ </nav>
86
+ <div class="pixel-line"></div>
87
+ <div class="rubber-band-gap"></div>
88
+ <article class="chapter">
89
+ <a name="/"></a>
90
+ <h1 class="chapter-name">Classes</h1>
91
+ <section>
92
+ <section class="section">
93
+ <p class="para">The following classes are available globally.</p>
94
+ </section>
95
+ <section class="section task-group-section">
96
+ <div class="task-group">
97
+ <div class="task-name-container">
98
+
99
+ <a name="/Classes"></a>
100
+ <a name="//apple_ref/swift/Section/Classes" class="dashAnchor"></a>
101
+ <a href="#/Classes">
102
+ <h3 class="section-name">Classes</h3>
103
+ </a>
104
+
105
+ </div>
106
+ <ul class="task-group-list">
107
+ <li class="item symbol">
108
+ <div class="task-group-term">
109
+ <code>
110
+ <a name="/s:C17MiscJazzyFeatures31ImplicitlyInternalTopLevelClass">
111
+ <a name="//apple_ref/swift/Class/ImplicitlyInternalTopLevelClass" class="dashAnchor"></a>
112
+ <a class="x-instance-method Swift" href="#/s:C17MiscJazzyFeatures31ImplicitlyInternalTopLevelClass">ImplicitlyInternalTopLevelClass</a>
113
+ </code>
114
+ </div>
115
+ <div class="height-container">
116
+ <div class="pointy-thing-container"></div>
117
+ <section class="section instance-method">
118
+ <div class="pointy-thing"></div>
119
+ <div class="abstract">
120
+ <p class="para">SUPPORTED: implicitly internal top-level class</p>
121
+ <a href="Classes/ImplicitlyInternalTopLevelClass.html" class="see-more">See more</a>
122
+ </div>
123
+ <div class="declaration">
124
+ <h4>Declaration</h4>
125
+
126
+ <div class="Swift">
127
+ <p class="aside-title">Swift</p>
128
+ <pre class="highlight"><code><span class="kd">class</span> <span class="kt">ImplicitlyInternalTopLevelClass</span></code></pre>
129
+
130
+ </div>
131
+ </div>
132
+ </section>
133
+ </div>
134
+ </li>
135
+ <li class="item symbol">
136
+ <div class="task-group-term">
137
+ <code>
138
+ <a name="/s:C17MiscJazzyFeatures31ExplicitlyInternalTopLevelClass">
139
+ <a name="//apple_ref/swift/Class/ExplicitlyInternalTopLevelClass" class="dashAnchor"></a>
140
+ <a class="x-instance-method Swift" href="#/s:C17MiscJazzyFeatures31ExplicitlyInternalTopLevelClass">ExplicitlyInternalTopLevelClass</a>
141
+ </code>
142
+ </div>
143
+ <div class="height-container">
144
+ <div class="pointy-thing-container"></div>
145
+ <section class="section instance-method">
146
+ <div class="pointy-thing"></div>
147
+ <div class="abstract">
148
+ <p class="para">SUPPORTED: explicitly internal top-level class</p>
149
+ </div>
150
+ <div class="declaration">
151
+ <h4>Declaration</h4>
152
+
153
+ <div class="Swift">
154
+ <p class="aside-title">Swift</p>
155
+ <pre class="highlight"><code><span class="kd">internal</span> <span class="kd">class</span> <span class="kt">ExplicitlyInternalTopLevelClass</span></code></pre>
156
+
157
+ </div>
158
+ </div>
159
+ </section>
160
+ </div>
161
+ </li>
162
+ <li class="item symbol">
163
+ <div class="task-group-term">
164
+ <code>
165
+ <a name="/s:C17MiscJazzyFeaturesP33_72F27992F5E059C6D84AD5FC86B1B76B20PrivateTopLevelClass">
166
+ <a name="//apple_ref/swift/Class/PrivateTopLevelClass" class="dashAnchor"></a>
167
+ <a class="x-instance-method Swift" href="#/s:C17MiscJazzyFeaturesP33_72F27992F5E059C6D84AD5FC86B1B76B20PrivateTopLevelClass">PrivateTopLevelClass</a>
168
+ </code>
169
+ </div>
170
+ <div class="height-container">
171
+ <div class="pointy-thing-container"></div>
172
+ <section class="section instance-method">
173
+ <div class="pointy-thing"></div>
174
+ <div class="abstract">
175
+ <p class="para">SUPPORTED: private top-level class</p>
176
+ </div>
177
+ <div class="declaration">
178
+ <h4>Declaration</h4>
179
+
180
+ <div class="Swift">
181
+ <p class="aside-title">Swift</p>
182
+ <pre class="highlight"><code><span class="kd">private</span> <span class="kd">class</span> <span class="kt">PrivateTopLevelClass</span></code></pre>
183
+
184
+ </div>
185
+ </div>
186
+ </section>
187
+ </div>
188
+ </li>
189
+ <li class="item symbol">
190
+ <div class="task-group-term">
191
+ <code>
192
+ <a name="/s:C17MiscJazzyFeatures19PublicTopLevelClass">
193
+ <a name="//apple_ref/swift/Class/PublicTopLevelClass" class="dashAnchor"></a>
194
+ <a class="x-instance-method Swift" href="#/s:C17MiscJazzyFeatures19PublicTopLevelClass">PublicTopLevelClass</a>
195
+ </code>
196
+ </div>
197
+ <div class="height-container">
198
+ <div class="pointy-thing-container"></div>
199
+ <section class="section instance-method">
200
+ <div class="pointy-thing"></div>
201
+ <div class="abstract">
202
+ <p class="para">SUPPORTED: public top-level class</p>
203
+ </div>
204
+ <div class="declaration">
205
+ <h4>Declaration</h4>
206
+
207
+ <div class="Swift">
208
+ <p class="aside-title">Swift</p>
209
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">PublicTopLevelClass</span></code></pre>
210
+
211
+ </div>
212
+ </div>
213
+ </section>
214
+ </div>
215
+ </li>
216
+ <li class="item symbol">
217
+ <div class="task-group-term">
218
+ <code>
219
+ <a name="/s:C17MiscJazzyFeatures17ObjCTopLevelClass">
220
+ <a name="//apple_ref/swift/Class/ObjCTopLevelClass" class="dashAnchor"></a>
221
+ <a class="x-instance-method Swift" href="#/s:C17MiscJazzyFeatures17ObjCTopLevelClass">ObjCTopLevelClass</a>
222
+ </code>
223
+ </div>
224
+ <div class="height-container">
225
+ <div class="pointy-thing-container"></div>
226
+ <section class="section instance-method">
227
+ <div class="pointy-thing"></div>
228
+ <div class="abstract">
229
+ <p class="para">SUPPORTED: @objc top-level class</p>
230
+ </div>
231
+ <div class="declaration">
232
+ <h4>Declaration</h4>
233
+
234
+ <div class="Swift">
235
+ <p class="aside-title">Swift</p>
236
+ <pre class="highlight"><code><span class="k">@objc</span> <span class="kd">class</span> <span class="kt">ObjCTopLevelClass</span></code></pre>
237
+
238
+ </div>
239
+ </div>
240
+ </section>
241
+ </div>
242
+ </li>
243
+ <li class="item symbol">
244
+ <div class="task-group-term">
245
+ <code>
246
+ <a name="/s:C17MiscJazzyFeatures20TopLevelObjCSubclass">
247
+ <a name="//apple_ref/swift/Class/TopLevelObjCSubclass" class="dashAnchor"></a>
248
+ <a class="x-instance-method Swift" href="#/s:C17MiscJazzyFeatures20TopLevelObjCSubclass">TopLevelObjCSubclass</a>
249
+ </code>
250
+ </div>
251
+ <div class="height-container">
252
+ <div class="pointy-thing-container"></div>
253
+ <section class="section instance-method">
254
+ <div class="pointy-thing"></div>
255
+ <div class="abstract">
256
+ <p class="para">SUPPORTED: top-level Objective-C subclasses</p>
257
+ </div>
258
+ <div class="declaration">
259
+ <h4>Declaration</h4>
260
+
261
+ <div class="Swift">
262
+ <p class="aside-title">Swift</p>
263
+ <pre class="highlight"><code><span class="kd">class</span> <span class="kt">TopLevelObjCSubclass</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
264
+
265
+ </div>
266
+ </div>
267
+ </section>
268
+ </div>
269
+ </li>
270
+ <li class="item symbol">
271
+ <div class="task-group-term">
272
+ <code>
273
+ <a name="/s:C17MiscJazzyFeatures21TopLevelSwiftSubclass">
274
+ <a name="//apple_ref/swift/Class/TopLevelSwiftSubclass" class="dashAnchor"></a>
275
+ <a class="x-instance-method Swift" href="#/s:C17MiscJazzyFeatures21TopLevelSwiftSubclass">TopLevelSwiftSubclass</a>
276
+ </code>
277
+ </div>
278
+ <div class="height-container">
279
+ <div class="pointy-thing-container"></div>
280
+ <section class="section instance-method">
281
+ <div class="pointy-thing"></div>
282
+ <div class="abstract">
283
+ <p class="para">SUPPORTED: top-level Swift subclasses</p>
284
+ </div>
285
+ <div class="declaration">
286
+ <h4>Declaration</h4>
287
+
288
+ <div class="Swift">
289
+ <p class="aside-title">Swift</p>
290
+ <pre class="highlight"><code><span class="kd">class</span> <span class="kt">TopLevelSwiftSubclass</span> <span class="p">:</span> <span class="kt">ImplicitlyInternalTopLevelClass</span></code></pre>
291
+
292
+ </div>
293
+ </div>
294
+ </section>
295
+ </div>
296
+ </li>
297
+ </ul>
298
+ </div>
299
+ </section>
300
+ </section>
301
+ <section id="footer">
302
+ <p class="copyright">&copy; YYYY <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">Realm</a>. All rights reserved. (Last updated: YYYY-MM-DD)</p>
303
+ <p class="copyright">Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ vX.X.X</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
304
+ </section>
305
+ </article>
306
+ </div>
307
+ </body>
308
+ </div>
309
+ </html>