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
@@ -3,12 +3,24 @@
3
3
  <head>
4
4
  <title>Manager Extension 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/Extension/Manager" class="dashAnchor"></a>
12
24
  <a title="Manager Extension Reference"></a>
13
25
  <header>
14
26
  <div class="content-wrapper">
@@ -167,6 +179,7 @@
167
179
  <div class="task-name-container">
168
180
 
169
181
  <a name="/Request"></a>
182
+ <a name="//apple_ref/swift/Section/Request" class="dashAnchor"></a>
170
183
  <a href="#/Request">
171
184
  <h3 class="section-name">Request</h3>
172
185
  </a>
@@ -177,6 +190,7 @@
177
190
  <div class="task-group-term">
178
191
  <code>
179
192
  <a name="/s:FC9Alamofire7Manager8downloadFS0_FTPS_21URLRequestConvertible_11destinationFTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request">
193
+ <a name="//apple_ref/swift/Method/download(_:destination:)" class="dashAnchor"></a>
180
194
  <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Manager8downloadFS0_FTPS_21URLRequestConvertible_11destinationFTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request">download(_:destination:)</a>
181
195
  </code>
182
196
  </div>
@@ -192,9 +206,8 @@
192
206
 
193
207
  <div class="Swift">
194
208
  <p class="aside-title">Swift</p>
195
- <p class="para">
196
- <code>public func download(URLRequest: URLRequestConvertible, destination: (NSURL, NSHTTPURLResponse) -&gt; (NSURL)) -&gt; Request</code>
197
- </p>
209
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">download</span><span class="p">(</span><span class="kt">URLRequest</span><span class="p">:</span> <span class="kt">URLRequestConvertible</span><span class="p">,</span> <span class="nv">destination</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSURL</span><span class="p">,</span> <span class="kt">NSHTTPURLResponse</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="p">(</span><span class="kt">NSURL</span><span class="p">))</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
210
+
198
211
  </div>
199
212
  </div>
200
213
  <div class="parameters">
@@ -244,6 +257,7 @@
244
257
  <div class="task-name-container">
245
258
 
246
259
  <a name="/Resume%20Data"></a>
260
+ <a name="//apple_ref/swift/Section/Resume Data" class="dashAnchor"></a>
247
261
  <a href="#/Resume%20Data">
248
262
  <h3 class="section-name">Resume Data</h3>
249
263
  </a>
@@ -254,6 +268,7 @@
254
268
  <div class="task-group-term">
255
269
  <code>
256
270
  <a name="/s:FC9Alamofire7Manager8downloadFS0_FTCSo6NSData11destinationFTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request">
271
+ <a name="//apple_ref/swift/Method/download(_:destination:)" class="dashAnchor"></a>
257
272
  <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Manager8downloadFS0_FTCSo6NSData11destinationFTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request">download(_:destination:)</a>
258
273
  </code>
259
274
  </div>
@@ -269,9 +284,8 @@
269
284
 
270
285
  <div class="Swift">
271
286
  <p class="aside-title">Swift</p>
272
- <p class="para">
273
- <code>public func download(resumeData: NSData, destination: Request.DownloadFileDestination) -&gt; Request</code>
274
- </p>
287
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">download</span><span class="p">(</span><span class="nv">resumeData</span><span class="p">:</span> <span class="kt">NSData</span><span class="p">,</span> <span class="nv">destination</span><span class="p">:</span> <span class="kt">Request</span><span class="o">.</span><span class="kt">DownloadFileDestination</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
288
+
275
289
  </div>
276
290
  </div>
277
291
  <div class="parameters">
@@ -3,12 +3,24 @@
3
3
  <head>
4
4
  <title>Request Extension 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/Extension/Request" class="dashAnchor"></a>
12
24
  <a title="Request Extension Reference"></a>
13
25
  <header>
14
26
  <div class="content-wrapper">
@@ -174,6 +186,7 @@
174
186
  <div class="task-group-term">
175
187
  <code>
176
188
  <a name="/s:FC9Alamofire7Request30propertyListResponseSerializerFMS0_FT7optionsSi_FTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqCSo6NSData__TGSqPSs9AnyObject__GSqCSo7NSError__">
189
+ <a name="//apple_ref/swift/Method/propertyListResponseSerializer(options:)" class="dashAnchor"></a>
177
190
  <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request30propertyListResponseSerializerFMS0_FT7optionsSi_FTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqCSo6NSData__TGSqPSs9AnyObject__GSqCSo7NSError__">propertyListResponseSerializer(options:)</a>
178
191
  </code>
179
192
  </div>
@@ -189,9 +202,8 @@
189
202
 
190
203
  <div class="Swift">
191
204
  <p class="aside-title">Swift</p>
192
- <p class="para">
193
- <code>public class func propertyListResponseSerializer(options: NSPropertyListReadOptions = default) -&gt; Serializer</code>
194
- </p>
205
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kd">func</span> <span class="nf">propertyListResponseSerializer</span><span class="p">(</span><span class="nv">options</span><span class="p">:</span> <span class="kt">NSPropertyListReadOptions</span> <span class="o">=</span> <span class="k">default</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Serializer</span></code></pre>
206
+
195
207
  </div>
196
208
  </div>
197
209
  <div class="parameters">
@@ -227,6 +239,7 @@
227
239
  <div class="task-group-term">
228
240
  <code>
229
241
  <a name="/s:FC9Alamofire7Request20responsePropertyListFDS0_FFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqPSs9AnyObject__GSqCSo7NSError__T_DS0_">
242
+ <a name="//apple_ref/swift/Method/responsePropertyList(_:)" class="dashAnchor"></a>
230
243
  <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request20responsePropertyListFDS0_FFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqPSs9AnyObject__GSqCSo7NSError__T_DS0_">responsePropertyList(_:)</a>
231
244
  </code>
232
245
  </div>
@@ -242,9 +255,8 @@
242
255
 
243
256
  <div class="Swift">
244
257
  <p class="aside-title">Swift</p>
245
- <p class="para">
246
- <code>public func responsePropertyList(completionHandler: (NSURLRequest, NSHTTPURLResponse?, AnyObject?, NSError?) -&gt; Void) -&gt; Self</code>
247
- </p>
258
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">responsePropertyList</span><span class="p">(</span><span class="nv">completionHandler</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSURLRequest</span><span class="p">,</span> <span class="kt">NSHTTPURLResponse</span><span class="p">?,</span> <span class="kt">AnyObject</span><span class="p">?,</span> <span class="kt">NSError</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
259
+
248
260
  </div>
249
261
  </div>
250
262
  <div class="parameters">
@@ -280,6 +292,7 @@
280
292
  <div class="task-group-term">
281
293
  <code>
282
294
  <a name="/s:FC9Alamofire7Request20responsePropertyListFDS0_FT7optionsSi17completionHandlerFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqPSs9AnyObject__GSqCSo7NSError__T__DS0_">
295
+ <a name="//apple_ref/swift/Method/responsePropertyList(options:completionHandler:)" class="dashAnchor"></a>
283
296
  <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request20responsePropertyListFDS0_FT7optionsSi17completionHandlerFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqPSs9AnyObject__GSqCSo7NSError__T__DS0_">responsePropertyList(options:completionHandler:)</a>
284
297
  </code>
285
298
  </div>
@@ -295,9 +308,8 @@
295
308
 
296
309
  <div class="Swift">
297
310
  <p class="aside-title">Swift</p>
298
- <p class="para">
299
- <code>public func responsePropertyList(options: NSPropertyListReadOptions = default, completionHandler: (NSURLRequest, NSHTTPURLResponse?, AnyObject?, NSError?) -&gt; Void) -&gt; Self</code>
300
- </p>
311
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">responsePropertyList</span><span class="p">(</span><span class="nv">options</span><span class="p">:</span> <span class="kt">NSPropertyListReadOptions</span> <span class="o">=</span> <span class="k">default</span><span class="p">,</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSURLRequest</span><span class="p">,</span> <span class="kt">NSHTTPURLResponse</span><span class="p">?,</span> <span class="kt">AnyObject</span><span class="p">?,</span> <span class="kt">NSError</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>
312
+
301
313
  </div>
302
314
  </div>
303
315
  <div class="parameters">
@@ -3,8 +3,19 @@
3
3
  <head>
4
4
  <title>Functions 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>
@@ -167,6 +178,7 @@
167
178
  <div class="task-name-container">
168
179
  <hr/>
169
180
  <a name="/Request"></a>
181
+ <a name="//apple_ref/swift/Section/Request" class="dashAnchor"></a>
170
182
  <a href="#/Request">
171
183
  <h3 class="section-name">Request</h3>
172
184
  </a>
@@ -177,6 +189,7 @@
177
189
  <div class="task-group-term">
178
190
  <code>
179
191
  <a name="/s:F9Alamofire7requestFTOS_6MethodPS_20URLStringConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject___8encodingOS_17ParameterEncoding_CS_7Request">
192
+ <a name="//apple_ref/swift/Function/request(_:_:parameters:encoding:)" class="dashAnchor"></a>
180
193
  <a class="x-instance-method Swift" href="#/s:F9Alamofire7requestFTOS_6MethodPS_20URLStringConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject___8encodingOS_17ParameterEncoding_CS_7Request">request(_:_:parameters:encoding:)</a>
181
194
  </code>
182
195
  </div>
@@ -192,9 +205,8 @@
192
205
 
193
206
  <div class="Swift">
194
207
  <p class="aside-title">Swift</p>
195
- <p class="para">
196
- <code>public func request(method: Method, URLString: URLStringConvertible, parameters: [String : AnyObject]? = default, encoding: ParameterEncoding = default) -&gt; Request</code>
197
- </p>
208
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">request</span><span class="p">(</span><span class="nv">method</span><span class="p">:</span> <span class="kt">Method</span><span class="p">,</span> <span class="kt">URLString</span><span class="p">:</span> <span class="kt">URLStringConvertible</span><span class="p">,</span> <span class="nv">parameters</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">AnyObject</span><span class="p">]?</span> <span class="o">=</span> <span class="k">default</span><span class="p">,</span> <span class="nv">encoding</span><span class="p">:</span> <span class="kt">ParameterEncoding</span> <span class="o">=</span> <span class="k">default</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
209
+
198
210
  </div>
199
211
  </div>
200
212
  <div class="parameters">
@@ -266,6 +278,7 @@
266
278
  <div class="task-group-term">
267
279
  <code>
268
280
  <a name="/s:F9Alamofire7requestFPS_21URLRequestConvertible_CS_7Request">
281
+ <a name="//apple_ref/swift/Function/request(_:)" class="dashAnchor"></a>
269
282
  <a class="x-instance-method Swift" href="#/s:F9Alamofire7requestFPS_21URLRequestConvertible_CS_7Request">request(_:)</a>
270
283
  </code>
271
284
  </div>
@@ -281,9 +294,8 @@
281
294
 
282
295
  <div class="Swift">
283
296
  <p class="aside-title">Swift</p>
284
- <p class="para">
285
- <code>public func request(URLRequest: URLRequestConvertible) -&gt; Request</code>
286
- </p>
297
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">request</span><span class="p">(</span><span class="kt">URLRequest</span><span class="p">:</span> <span class="kt">URLRequestConvertible</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
298
+
287
299
  </div>
288
300
  </div>
289
301
  <div class="parameters">
@@ -321,6 +333,7 @@
321
333
  <div class="task-name-container">
322
334
 
323
335
  <a name="/File"></a>
336
+ <a name="//apple_ref/swift/Section/File" class="dashAnchor"></a>
324
337
  <a href="#/File">
325
338
  <h3 class="section-name">File</h3>
326
339
  </a>
@@ -331,6 +344,7 @@
331
344
  <div class="task-group-term">
332
345
  <code>
333
346
  <a name="/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo5NSURL_CS_7Request">
347
+ <a name="//apple_ref/swift/Function/upload(_:_:_:)" class="dashAnchor"></a>
334
348
  <a class="x-instance-method Swift" href="#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo5NSURL_CS_7Request">upload(_:_:_:)</a>
335
349
  </code>
336
350
  </div>
@@ -346,9 +360,8 @@
346
360
 
347
361
  <div class="Swift">
348
362
  <p class="aside-title">Swift</p>
349
- <p class="para">
350
- <code>public func upload(method: Method, URLString: URLStringConvertible, file: NSURL) -&gt; Request</code>
351
- </p>
363
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="nv">method</span><span class="p">:</span> <span class="kt">Method</span><span class="p">,</span> <span class="kt">URLString</span><span class="p">:</span> <span class="kt">URLStringConvertible</span><span class="p">,</span> <span class="nv">file</span><span class="p">:</span> <span class="kt">NSURL</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
364
+
352
365
  </div>
353
366
  </div>
354
367
  <div class="parameters">
@@ -408,6 +421,7 @@
408
421
  <div class="task-group-term">
409
422
  <code>
410
423
  <a name="/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo5NSURL_CS_7Request">
424
+ <a name="//apple_ref/swift/Function/upload(_:_:)" class="dashAnchor"></a>
411
425
  <a class="x-instance-method Swift" href="#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo5NSURL_CS_7Request">upload(_:_:)</a>
412
426
  </code>
413
427
  </div>
@@ -423,9 +437,8 @@
423
437
 
424
438
  <div class="Swift">
425
439
  <p class="aside-title">Swift</p>
426
- <p class="para">
427
- <code>public func upload(URLRequest: URLRequestConvertible, file: NSURL) -&gt; Request</code>
428
- </p>
440
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="kt">URLRequest</span><span class="p">:</span> <span class="kt">URLRequestConvertible</span><span class="p">,</span> <span class="nv">file</span><span class="p">:</span> <span class="kt">NSURL</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
441
+
429
442
  </div>
430
443
  </div>
431
444
  <div class="parameters">
@@ -475,6 +488,7 @@
475
488
  <div class="task-name-container">
476
489
 
477
490
  <a name="/Data"></a>
491
+ <a name="//apple_ref/swift/Section/Data" class="dashAnchor"></a>
478
492
  <a href="#/Data">
479
493
  <h3 class="section-name">Data</h3>
480
494
  </a>
@@ -485,6 +499,7 @@
485
499
  <div class="task-group-term">
486
500
  <code>
487
501
  <a name="/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo6NSData_CS_7Request">
502
+ <a name="//apple_ref/swift/Function/upload(_:_:_:)" class="dashAnchor"></a>
488
503
  <a class="x-instance-method Swift" href="#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo6NSData_CS_7Request">upload(_:_:_:)</a>
489
504
  </code>
490
505
  </div>
@@ -500,9 +515,8 @@
500
515
 
501
516
  <div class="Swift">
502
517
  <p class="aside-title">Swift</p>
503
- <p class="para">
504
- <code>public func upload(method: Method, URLString: URLStringConvertible, data: NSData) -&gt; Request</code>
505
- </p>
518
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="nv">method</span><span class="p">:</span> <span class="kt">Method</span><span class="p">,</span> <span class="kt">URLString</span><span class="p">:</span> <span class="kt">URLStringConvertible</span><span class="p">,</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">NSData</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
519
+
506
520
  </div>
507
521
  </div>
508
522
  <div class="parameters">
@@ -562,6 +576,7 @@
562
576
  <div class="task-group-term">
563
577
  <code>
564
578
  <a name="/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo6NSData_CS_7Request">
579
+ <a name="//apple_ref/swift/Function/upload(_:_:)" class="dashAnchor"></a>
565
580
  <a class="x-instance-method Swift" href="#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo6NSData_CS_7Request">upload(_:_:)</a>
566
581
  </code>
567
582
  </div>
@@ -577,9 +592,8 @@
577
592
 
578
593
  <div class="Swift">
579
594
  <p class="aside-title">Swift</p>
580
- <p class="para">
581
- <code>public func upload(URLRequest: URLRequestConvertible, data: NSData) -&gt; Request</code>
582
- </p>
595
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="kt">URLRequest</span><span class="p">:</span> <span class="kt">URLRequestConvertible</span><span class="p">,</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">NSData</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
596
+
583
597
  </div>
584
598
  </div>
585
599
  <div class="parameters">
@@ -629,6 +643,7 @@
629
643
  <div class="task-name-container">
630
644
 
631
645
  <a name="/Stream"></a>
646
+ <a name="//apple_ref/swift/Section/Stream" class="dashAnchor"></a>
632
647
  <a href="#/Stream">
633
648
  <h3 class="section-name">Stream</h3>
634
649
  </a>
@@ -639,6 +654,7 @@
639
654
  <div class="task-group-term">
640
655
  <code>
641
656
  <a name="/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo13NSInputStream_CS_7Request">
657
+ <a name="//apple_ref/swift/Function/upload(_:_:_:)" class="dashAnchor"></a>
642
658
  <a class="x-instance-method Swift" href="#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:_:)</a>
643
659
  </code>
644
660
  </div>
@@ -654,9 +670,8 @@
654
670
 
655
671
  <div class="Swift">
656
672
  <p class="aside-title">Swift</p>
657
- <p class="para">
658
- <code>public func upload(method: Method, URLString: URLStringConvertible, stream: NSInputStream) -&gt; Request</code>
659
- </p>
673
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="nv">method</span><span class="p">:</span> <span class="kt">Method</span><span class="p">,</span> <span class="kt">URLString</span><span class="p">:</span> <span class="kt">URLStringConvertible</span><span class="p">,</span> <span class="nv">stream</span><span class="p">:</span> <span class="kt">NSInputStream</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
674
+
660
675
  </div>
661
676
  </div>
662
677
  <div class="parameters">
@@ -716,6 +731,7 @@
716
731
  <div class="task-group-term">
717
732
  <code>
718
733
  <a name="/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo13NSInputStream_CS_7Request">
734
+ <a name="//apple_ref/swift/Function/upload(_:_:)" class="dashAnchor"></a>
719
735
  <a class="x-instance-method Swift" href="#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:)</a>
720
736
  </code>
721
737
  </div>
@@ -731,9 +747,8 @@
731
747
 
732
748
  <div class="Swift">
733
749
  <p class="aside-title">Swift</p>
734
- <p class="para">
735
- <code>public func upload(URLRequest: URLRequestConvertible, stream: NSInputStream) -&gt; Request</code>
736
- </p>
750
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="kt">URLRequest</span><span class="p">:</span> <span class="kt">URLRequestConvertible</span><span class="p">,</span> <span class="nv">stream</span><span class="p">:</span> <span class="kt">NSInputStream</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
751
+
737
752
  </div>
738
753
  </div>
739
754
  <div class="parameters">
@@ -783,6 +798,7 @@
783
798
  <div class="task-name-container">
784
799
 
785
800
  <a name="/URL%20Request"></a>
801
+ <a name="//apple_ref/swift/Section/URL Request" class="dashAnchor"></a>
786
802
  <a href="#/URL%20Request">
787
803
  <h3 class="section-name">URL Request</h3>
788
804
  </a>
@@ -793,6 +809,7 @@
793
809
  <div class="task-group-term">
794
810
  <code>
795
811
  <a name="/s:F9Alamofire8downloadFTOS_6MethodPS_20URLStringConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request">
812
+ <a name="//apple_ref/swift/Function/download(_:_:_:)" class="dashAnchor"></a>
796
813
  <a class="x-instance-method Swift" href="#/s:F9Alamofire8downloadFTOS_6MethodPS_20URLStringConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request">download(_:_:_:)</a>
797
814
  </code>
798
815
  </div>
@@ -808,9 +825,8 @@
808
825
 
809
826
  <div class="Swift">
810
827
  <p class="aside-title">Swift</p>
811
- <p class="para">
812
- <code>public func download(method: Method, URLString: URLStringConvertible, destination: Request.DownloadFileDestination) -&gt; Request</code>
813
- </p>
828
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">download</span><span class="p">(</span><span class="nv">method</span><span class="p">:</span> <span class="kt">Method</span><span class="p">,</span> <span class="kt">URLString</span><span class="p">:</span> <span class="kt">URLStringConvertible</span><span class="p">,</span> <span class="nv">destination</span><span class="p">:</span> <span class="kt">Request</span><span class="o">.</span><span class="kt">DownloadFileDestination</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
829
+
814
830
  </div>
815
831
  </div>
816
832
  <div class="parameters">
@@ -870,6 +886,7 @@
870
886
  <div class="task-group-term">
871
887
  <code>
872
888
  <a name="/s:F9Alamofire8downloadFTPS_21URLRequestConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">
889
+ <a name="//apple_ref/swift/Function/download(_:_:)" class="dashAnchor"></a>
873
890
  <a class="x-instance-method Swift" href="#/s:F9Alamofire8downloadFTPS_21URLRequestConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(_:_:)</a>
874
891
  </code>
875
892
  </div>
@@ -885,9 +902,8 @@
885
902
 
886
903
  <div class="Swift">
887
904
  <p class="aside-title">Swift</p>
888
- <p class="para">
889
- <code>public func download(URLRequest: URLRequestConvertible, destination: Request.DownloadFileDestination) -&gt; Request</code>
890
- </p>
905
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">download</span><span class="p">(</span><span class="kt">URLRequest</span><span class="p">:</span> <span class="kt">URLRequestConvertible</span><span class="p">,</span> <span class="nv">destination</span><span class="p">:</span> <span class="kt">Request</span><span class="o">.</span><span class="kt">DownloadFileDestination</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
906
+
891
907
  </div>
892
908
  </div>
893
909
  <div class="parameters">
@@ -937,6 +953,7 @@
937
953
  <div class="task-name-container">
938
954
 
939
955
  <a name="/Resume%20Data"></a>
956
+ <a name="//apple_ref/swift/Section/Resume Data" class="dashAnchor"></a>
940
957
  <a href="#/Resume%20Data">
941
958
  <h3 class="section-name">Resume Data</h3>
942
959
  </a>
@@ -947,6 +964,7 @@
947
964
  <div class="task-group-term">
948
965
  <code>
949
966
  <a name="/s:F9Alamofire8downloadFT10resumeDataCSo6NSDataFTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">
967
+ <a name="//apple_ref/swift/Function/download(resumeData:_:)" class="dashAnchor"></a>
950
968
  <a class="x-instance-method Swift" href="#/s:F9Alamofire8downloadFT10resumeDataCSo6NSDataFTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(resumeData:_:)</a>
951
969
  </code>
952
970
  </div>
@@ -962,9 +980,8 @@
962
980
 
963
981
  <div class="Swift">
964
982
  <p class="aside-title">Swift</p>
965
- <p class="para">
966
- <code>public func download(resumeData data: NSData, destination: Request.DownloadFileDestination) -&gt; Request</code>
967
- </p>
983
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">download</span><span class="p">(</span><span class="n">resumeData</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">NSData</span><span class="p">,</span> <span class="nv">destination</span><span class="p">:</span> <span class="kt">Request</span><span class="o">.</span><span class="kt">DownloadFileDestination</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Request</span></code></pre>
984
+
968
985
  </div>
969
986
  </div>
970
987
  <div class="parameters">
@@ -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>
@@ -174,6 +185,7 @@
174
185
  <div class="task-group-term">
175
186
  <code>
176
187
  <a name="/s:v9Alamofire20AlamofireErrorDomainSS">
188
+ <a name="//apple_ref/swift/Global/AlamofireErrorDomain" class="dashAnchor"></a>
177
189
  <a class="x-instance-method Swift" href="#/s:v9Alamofire20AlamofireErrorDomainSS">AlamofireErrorDomain</a>
178
190
  </code>
179
191
  </div>
@@ -189,9 +201,8 @@
189
201
 
190
202
  <div class="Swift">
191
203
  <p class="aside-title">Swift</p>
192
- <p class="para">
193
- <code>public let AlamofireErrorDomain: String</code>
194
- </p>
204
+ <pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">AlamofireErrorDomain</span><span class="p">:</span> <span class="kt">String</span></code></pre>
205
+
195
206
  </div>
196
207
  </div>
197
208
  <div class="result-description view-on-github">