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
data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Protocols/URLStringConvertible.html ADDED
@@ -0,0 +1,227 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <title>URLStringConvertible Protocol 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 name="//apple_ref/swift/Protocol/URLStringConvertible" class="dashAnchor"></a>
24
+ <a title="URLStringConvertible Protocol Reference"></a>
25
+ <header>
26
+ <div class="content-wrapper">
27
+ <p class="header-text"><a href="../index.html">Alamofire Docs</a> (40% documented)</p>
28
+ <p id="header-links"><a href="https://github.com/Alamofire/Alamofire"><img id="header-icon" src="../img/gh.png" height="16px" width="16px" />View on GitHub</a></p>
29
+ </div>
30
+ </header>
31
+ <section id="valence">
32
+ <div class="content-wrapper">
33
+ <p id="hierarchial_navigation">
34
+ <a href="../index.html" id="design_resources_link">Alamofire Reference</a>
35
+ <img id="carat" src="../img/carat.png" height="10px" width="6px" />
36
+ URLStringConvertible Protocol Reference
37
+ </p>
38
+ </div>
39
+ </section>
40
+ <div class="content-wrapper">
41
+ <nav class="book-parts">
42
+ <ul class="nav-parts">
43
+ <li class="part-name tasks">
44
+ <a href="../Classes.html">Classes</a>
45
+ <ul class="nav-chapters">
46
+ <li class="nav-chapter">
47
+ <a href="../Classes/Manager.html">Manager</a>
48
+ </li>
49
+ <li class="nav-chapter">
50
+ <a href="../Classes/Request.html">Request</a>
51
+ </li>
52
+ </ul>
53
+ </li>
54
+ <li class="part-name tasks">
55
+ <a href="../Global Variables.html">Global Variables</a>
56
+ <ul class="nav-chapters">
57
+ <li class="nav-chapter">
58
+ <a href="../Global Variables.html#/s:v9Alamofire20AlamofireErrorDomainSS">AlamofireErrorDomain</a>
59
+ </li>
60
+ </ul>
61
+ </li>
62
+ <li class="part-name tasks">
63
+ <a href="../Enums.html">Enums</a>
64
+ <ul class="nav-chapters">
65
+ <li class="nav-chapter">
66
+ <a href="../Enums.html#/s:O9Alamofire6Method">Method</a>
67
+ </li>
68
+ <li class="nav-chapter">
69
+ <a href="../Enums/ParameterEncoding.html">ParameterEncoding</a>
70
+ </li>
71
+ </ul>
72
+ </li>
73
+ <li class="part-name tasks">
74
+ <a href="../Extensions.html">Extensions</a>
75
+ <ul class="nav-chapters">
76
+ <li class="nav-chapter">
77
+ <a href="../Extensions.html#/s:SS">String</a>
78
+ </li>
79
+ <li class="nav-chapter">
80
+ <a href="../Extensions.html#/c:objc(cs)NSURLRequest">NSURLRequest</a>
81
+ </li>
82
+ <li class="nav-chapter">
83
+ <a href="../Extensions.html#/c:objc(cs)NSURLRequest">NSURLRequest</a>
84
+ </li>
85
+ <li class="nav-chapter">
86
+ <a href="../Extensions/Request.html">Request</a>
87
+ </li>
88
+ <li class="nav-chapter">
89
+ <a href="../Extensions/Manager.html">Manager</a>
90
+ </li>
91
+ <li class="nav-chapter">
92
+ <a href="../Extensions.html#/s:C9Alamofire7Request">Request</a>
93
+ </li>
94
+ <li class="nav-chapter">
95
+ <a href="../Extensions/Manager.html">Manager</a>
96
+ </li>
97
+ <li class="nav-chapter">
98
+ <a href="../Extensions/Request.html">Request</a>
99
+ </li>
100
+ <li class="nav-chapter">
101
+ <a href="../Extensions/Request.html">Request</a>
102
+ </li>
103
+ <li class="nav-chapter">
104
+ <a href="../Extensions/Request.html">Request</a>
105
+ </li>
106
+ <li class="nav-chapter">
107
+ <a href="../Extensions/Request.html">Request</a>
108
+ </li>
109
+ <li class="nav-chapter">
110
+ <a href="../Extensions/Request.html">Request</a>
111
+ </li>
112
+ <li class="nav-chapter">
113
+ <a href="../Extensions/Request.html">Request</a>
114
+ </li>
115
+ </ul>
116
+ </li>
117
+ <li class="part-name tasks">
118
+ <a href="../Functions.html">Functions</a>
119
+ <ul class="nav-chapters">
120
+ <li class="nav-chapter">
121
+ <a href="../Functions.html#/s:F9Alamofire7requestFTOS_6MethodPS_20URLStringConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject___8encodingOS_17ParameterEncoding_CS_7Request">request(_:_:parameters:encoding:)</a>
122
+ </li>
123
+ <li class="nav-chapter">
124
+ <a href="../Functions.html#/s:F9Alamofire7requestFPS_21URLRequestConvertible_CS_7Request">request(_:)</a>
125
+ </li>
126
+ <li class="nav-chapter">
127
+ <a href="../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo5NSURL_CS_7Request">upload(_:_:_:)</a>
128
+ </li>
129
+ <li class="nav-chapter">
130
+ <a href="../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo5NSURL_CS_7Request">upload(_:_:)</a>
131
+ </li>
132
+ <li class="nav-chapter">
133
+ <a href="../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo6NSData_CS_7Request">upload(_:_:_:)</a>
134
+ </li>
135
+ <li class="nav-chapter">
136
+ <a href="../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo6NSData_CS_7Request">upload(_:_:)</a>
137
+ </li>
138
+ <li class="nav-chapter">
139
+ <a href="../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:_:)</a>
140
+ </li>
141
+ <li class="nav-chapter">
142
+ <a href="../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:)</a>
143
+ </li>
144
+ <li class="nav-chapter">
145
+ <a href="../Functions.html#/s:F9Alamofire8downloadFTOS_6MethodPS_20URLStringConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request">download(_:_:_:)</a>
146
+ </li>
147
+ <li class="nav-chapter">
148
+ <a href="../Functions.html#/s:F9Alamofire8downloadFTPS_21URLRequestConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(_:_:)</a>
149
+ </li>
150
+ <li class="nav-chapter">
151
+ <a href="../Functions.html#/s:F9Alamofire8downloadFT10resumeDataCSo6NSDataFTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(resumeData:_:)</a>
152
+ </li>
153
+ </ul>
154
+ </li>
155
+ <li class="part-name tasks">
156
+ <a href="../Protocols.html">Protocols</a>
157
+ <ul class="nav-chapters">
158
+ <li class="nav-chapter">
159
+ <a href="../Protocols/URLStringConvertible.html">URLStringConvertible</a>
160
+ </li>
161
+ <li class="nav-chapter">
162
+ <a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
163
+ </li>
164
+ </ul>
165
+ </li>
166
+ </ul>
167
+ </nav>
168
+ <div class="pixel-line"></div>
169
+ <div class="rubber-band-gap"></div>
170
+ <article class="chapter">
171
+ <a name="/"></a>
172
+ <h1 class="chapter-name">URLStringConvertible</h1>
173
+ <section>
174
+ <section class="section">
175
+ <p class="para">Types adopting the <code>URLStringConvertible</code> protocol can be used to construct URL strings, which are then used to construct URL requests.</p>
176
+ </section>
177
+ <section class="section task-group-section">
178
+ <div class="task-group">
179
+ <div class="task-name-container">
180
+
181
+ <a name="/Unnamed"></a>
182
+
183
+ </div>
184
+ <ul class="task-group-list">
185
+ <li class="item symbol">
186
+ <div class="task-group-term">
187
+ <code>
188
+ <a name="/s:vP9Alamofire20URLStringConvertible9URLStringSS">
189
+ <a name="//apple_ref/swift/Property/URLString" class="dashAnchor"></a>
190
+ <a class="x-instance-method Swift" href="#/s:vP9Alamofire20URLStringConvertible9URLStringSS">URLString</a>
191
+ </code>
192
+ </div>
193
+ <div class="height-container">
194
+ <div class="pointy-thing-container"></div>
195
+ <section class="section instance-method">
196
+ <div class="pointy-thing"></div>
197
+ <div class="abstract">
198
+ <p class="para">The URL string.</p>
199
+ </div>
200
+ <div class="declaration">
201
+ <h4>Declaration</h4>
202
+
203
+ <div class="Swift">
204
+ <p class="aside-title">Swift</p>
205
+ <pre class="highlight"><code><span class="k">var</span> <span class="nv">URLString</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre>
206
+
207
+ </div>
208
+ </div>
209
+ <div class="result-description view-on-github">
210
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L167">Show on GitHub</a>
211
+ </div>
212
+ </section>
213
+ </div>
214
+ </li>
215
+ </ul>
216
+ </div>
217
+ </section>
218
+ </section>
219
+ <section id="footer">
220
+ <p class="copyright">&copy; YYYY <a class="link" href="https://nshipster.com/alamofire" target="_blank" rel="external">Alamofire</a>. All rights reserved. (Last updated: YYYY-MM-DD)</p>
221
+ <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>
222
+ </section>
223
+ </article>
224
+ </div>
225
+ </body>
226
+ </div>
227
+ </html>
data/spec/integration_specs/document_alamofire/after/docs/Alamofire.docset/Contents/Resources/Documents/Request.html ADDED
@@ -0,0 +1,368 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <title>Request Extension 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 name="//apple_ref/swift/Extension/Request" class="dashAnchor"></a>
24
+ <a title="Request Extension Reference"></a>
25
+ <header>
26
+ <div class="content-wrapper">
27
+ <p class="header-text"><a href="../index.html">Alamofire Docs</a> (40% documented)</p>
28
+ <p id="header-links"><a href="https://github.com/Alamofire/Alamofire"><img id="header-icon" src="../img/gh.png" height="16px" width="16px" />View on GitHub</a></p>
29
+ </div>
30
+ </header>
31
+ <section id="valence">
32
+ <div class="content-wrapper">
33
+ <p id="hierarchial_navigation">
34
+ <a href="../index.html" id="design_resources_link">Alamofire Reference</a>
35
+ <img id="carat" src="../img/carat.png" height="10px" width="6px" />
36
+ Request Extension Reference
37
+ </p>
38
+ </div>
39
+ </section>
40
+ <div class="content-wrapper">
41
+ <nav class="book-parts">
42
+ <ul class="nav-parts">
43
+ <li class="part-name tasks">
44
+ <a href="../Classes.html">Classes</a>
45
+ <ul class="nav-chapters">
46
+ <li class="nav-chapter">
47
+ <a href="../Classes/Manager.html">Manager</a>
48
+ </li>
49
+ <li class="nav-chapter">
50
+ <a href="../Classes/Request.html">Request</a>
51
+ </li>
52
+ </ul>
53
+ </li>
54
+ <li class="part-name tasks">
55
+ <a href="../Global Variables.html">Global Variables</a>
56
+ <ul class="nav-chapters">
57
+ <li class="nav-chapter">
58
+ <a href="../Global Variables.html#/s:v9Alamofire20AlamofireErrorDomainSS">AlamofireErrorDomain</a>
59
+ </li>
60
+ </ul>
61
+ </li>
62
+ <li class="part-name tasks">
63
+ <a href="../Enums.html">Enums</a>
64
+ <ul class="nav-chapters">
65
+ <li class="nav-chapter">
66
+ <a href="../Enums.html#/s:O9Alamofire6Method">Method</a>
67
+ </li>
68
+ <li class="nav-chapter">
69
+ <a href="../Enums/ParameterEncoding.html">ParameterEncoding</a>
70
+ </li>
71
+ </ul>
72
+ </li>
73
+ <li class="part-name tasks">
74
+ <a href="../Extensions.html">Extensions</a>
75
+ <ul class="nav-chapters">
76
+ <li class="nav-chapter">
77
+ <a href="../Extensions.html#/s:SS">String</a>
78
+ </li>
79
+ <li class="nav-chapter">
80
+ <a href="../Extensions.html#/c:objc(cs)NSURLRequest">NSURLRequest</a>
81
+ </li>
82
+ <li class="nav-chapter">
83
+ <a href="../Extensions.html#/c:objc(cs)NSURLRequest">NSURLRequest</a>
84
+ </li>
85
+ <li class="nav-chapter">
86
+ <a href="../Extensions/Request.html">Request</a>
87
+ </li>
88
+ <li class="nav-chapter">
89
+ <a href="../Extensions/Manager.html">Manager</a>
90
+ </li>
91
+ <li class="nav-chapter">
92
+ <a href="../Extensions.html#/s:C9Alamofire7Request">Request</a>
93
+ </li>
94
+ <li class="nav-chapter">
95
+ <a href="../Extensions/Manager.html">Manager</a>
96
+ </li>
97
+ <li class="nav-chapter">
98
+ <a href="../Extensions/Request.html">Request</a>
99
+ </li>
100
+ <li class="nav-chapter">
101
+ <a href="../Extensions/Request.html">Request</a>
102
+ </li>
103
+ <li class="nav-chapter">
104
+ <a href="../Extensions/Request.html">Request</a>
105
+ </li>
106
+ <li class="nav-chapter">
107
+ <a href="../Extensions/Request.html">Request</a>
108
+ </li>
109
+ <li class="nav-chapter">
110
+ <a href="../Extensions/Request.html">Request</a>
111
+ </li>
112
+ <li class="nav-chapter">
113
+ <a href="../Extensions/Request.html">Request</a>
114
+ </li>
115
+ </ul>
116
+ </li>
117
+ <li class="part-name tasks">
118
+ <a href="../Functions.html">Functions</a>
119
+ <ul class="nav-chapters">
120
+ <li class="nav-chapter">
121
+ <a href="../Functions.html#/s:F9Alamofire7requestFTOS_6MethodPS_20URLStringConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject___8encodingOS_17ParameterEncoding_CS_7Request">request(_:_:parameters:encoding:)</a>
122
+ </li>
123
+ <li class="nav-chapter">
124
+ <a href="../Functions.html#/s:F9Alamofire7requestFPS_21URLRequestConvertible_CS_7Request">request(_:)</a>
125
+ </li>
126
+ <li class="nav-chapter">
127
+ <a href="../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo5NSURL_CS_7Request">upload(_:_:_:)</a>
128
+ </li>
129
+ <li class="nav-chapter">
130
+ <a href="../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo5NSURL_CS_7Request">upload(_:_:)</a>
131
+ </li>
132
+ <li class="nav-chapter">
133
+ <a href="../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo6NSData_CS_7Request">upload(_:_:_:)</a>
134
+ </li>
135
+ <li class="nav-chapter">
136
+ <a href="../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo6NSData_CS_7Request">upload(_:_:)</a>
137
+ </li>
138
+ <li class="nav-chapter">
139
+ <a href="../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:_:)</a>
140
+ </li>
141
+ <li class="nav-chapter">
142
+ <a href="../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:)</a>
143
+ </li>
144
+ <li class="nav-chapter">
145
+ <a href="../Functions.html#/s:F9Alamofire8downloadFTOS_6MethodPS_20URLStringConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request">download(_:_:_:)</a>
146
+ </li>
147
+ <li class="nav-chapter">
148
+ <a href="../Functions.html#/s:F9Alamofire8downloadFTPS_21URLRequestConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(_:_:)</a>
149
+ </li>
150
+ <li class="nav-chapter">
151
+ <a href="../Functions.html#/s:F9Alamofire8downloadFT10resumeDataCSo6NSDataFTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(resumeData:_:)</a>
152
+ </li>
153
+ </ul>
154
+ </li>
155
+ <li class="part-name tasks">
156
+ <a href="../Protocols.html">Protocols</a>
157
+ <ul class="nav-chapters">
158
+ <li class="nav-chapter">
159
+ <a href="../Protocols/URLStringConvertible.html">URLStringConvertible</a>
160
+ </li>
161
+ <li class="nav-chapter">
162
+ <a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
163
+ </li>
164
+ </ul>
165
+ </li>
166
+ </ul>
167
+ </nav>
168
+ <div class="pixel-line"></div>
169
+ <div class="rubber-band-gap"></div>
170
+ <article class="chapter">
171
+ <a name="/"></a>
172
+ <h1 class="chapter-name">Request</h1>
173
+ <section>
174
+ <section class="section">
175
+ <p class="para">Responsible for sending a request and receiving the response and associated data from the server, as well as managing its underlying <code>NSURLSessionTask</code>.</p>
176
+ </section>
177
+ <section class="section task-group-section">
178
+ <div class="task-group">
179
+ <div class="task-name-container">
180
+
181
+ <a name="/Unnamed"></a>
182
+
183
+ </div>
184
+ <ul class="task-group-list">
185
+ <li class="item symbol">
186
+ <div class="task-group-term">
187
+ <code>
188
+ <a name="/s:FC9Alamofire7Request30propertyListResponseSerializerFMS0_FT7optionsSi_FTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqCSo6NSData__TGSqPSs9AnyObject__GSqCSo7NSError__">
189
+ <a name="//apple_ref/swift/Method/propertyListResponseSerializer(options:)" class="dashAnchor"></a>
190
+ <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request30propertyListResponseSerializerFMS0_FT7optionsSi_FTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqCSo6NSData__TGSqPSs9AnyObject__GSqCSo7NSError__">propertyListResponseSerializer(options:)</a>
191
+ </code>
192
+ </div>
193
+ <div class="height-container">
194
+ <div class="pointy-thing-container"></div>
195
+ <section class="section instance-method">
196
+ <div class="pointy-thing"></div>
197
+ <div class="abstract">
198
+ <p class="para">Creates a response serializer that returns an object constructed from the response data using <code>NSPropertyListSerialization</code> with the specified reading options.</p>
199
+ </div>
200
+ <div class="declaration">
201
+ <h4>Declaration</h4>
202
+
203
+ <div class="Swift">
204
+ <p class="aside-title">Swift</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
+
207
+ </div>
208
+ </div>
209
+ <div class="parameters">
210
+ <h4>Parameters</h4>
211
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
212
+ <tbody>
213
+ <tr>
214
+ <td scope="row">
215
+ <code>
216
+ <em class="term">options</em>
217
+ </code>
218
+ </td>
219
+ <td>
220
+ <div class="definition">
221
+ <p class="para">The property list reading options. <code>0</code> by default.</p>
222
+ </div>
223
+ </td>
224
+ </tr>
225
+ </tbody>
226
+ </table>
227
+ </div>
228
+ <div class="result-description">
229
+ <h4>Return Value</h4>
230
+ <p class="para">A property list object response serializer.</p>
231
+ </div>
232
+ <div class="result-description view-on-github">
233
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1401">Show on GitHub</a>
234
+ </div>
235
+ </section>
236
+ </div>
237
+ </li>
238
+ <li class="item symbol">
239
+ <div class="task-group-term">
240
+ <code>
241
+ <a name="/s:FC9Alamofire7Request20responsePropertyListFDS0_FFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqPSs9AnyObject__GSqCSo7NSError__T_DS0_">
242
+ <a name="//apple_ref/swift/Method/responsePropertyList(_:)" class="dashAnchor"></a>
243
+ <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request20responsePropertyListFDS0_FFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqPSs9AnyObject__GSqCSo7NSError__T_DS0_">responsePropertyList(_:)</a>
244
+ </code>
245
+ </div>
246
+ <div class="height-container">
247
+ <div class="pointy-thing-container"></div>
248
+ <section class="section instance-method">
249
+ <div class="pointy-thing"></div>
250
+ <div class="abstract">
251
+ <p class="para">Adds a handler to be called once the request has finished.</p>
252
+ </div>
253
+ <div class="declaration">
254
+ <h4>Declaration</h4>
255
+
256
+ <div class="Swift">
257
+ <p class="aside-title">Swift</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
+
260
+ </div>
261
+ </div>
262
+ <div class="parameters">
263
+ <h4>Parameters</h4>
264
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
265
+ <tbody>
266
+ <tr>
267
+ <td scope="row">
268
+ <code>
269
+ <em class="term">completionHandler</em>
270
+ </code>
271
+ </td>
272
+ <td>
273
+ <div class="definition">
274
+ <p class="para">A closure to be executed once the request has finished. The closure takes 4 arguments: the URL request, the URL response, if one was received, the property list, if one could be created from the URL response and data, and any error produced while creating the property list.</p>
275
+ </div>
276
+ </td>
277
+ </tr>
278
+ </tbody>
279
+ </table>
280
+ </div>
281
+ <div class="result-description">
282
+ <h4>Return Value</h4>
283
+ <p class="para">The request.</p>
284
+ </div>
285
+ <div class="result-description view-on-github">
286
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1421">Show on GitHub</a>
287
+ </div>
288
+ </section>
289
+ </div>
290
+ </li>
291
+ <li class="item symbol">
292
+ <div class="task-group-term">
293
+ <code>
294
+ <a name="/s:FC9Alamofire7Request20responsePropertyListFDS0_FT7optionsSi17completionHandlerFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqPSs9AnyObject__GSqCSo7NSError__T__DS0_">
295
+ <a name="//apple_ref/swift/Method/responsePropertyList(options:completionHandler:)" class="dashAnchor"></a>
296
+ <a class="x-instance-method Swift" href="#/s:FC9Alamofire7Request20responsePropertyListFDS0_FT7optionsSi17completionHandlerFTCSo12NSURLRequestGSqCSo17NSHTTPURLResponse_GSqPSs9AnyObject__GSqCSo7NSError__T__DS0_">responsePropertyList(options:completionHandler:)</a>
297
+ </code>
298
+ </div>
299
+ <div class="height-container">
300
+ <div class="pointy-thing-container"></div>
301
+ <section class="section instance-method">
302
+ <div class="pointy-thing"></div>
303
+ <div class="abstract">
304
+ <p class="para">Adds a handler to be called once the request has finished.</p>
305
+ </div>
306
+ <div class="declaration">
307
+ <h4>Declaration</h4>
308
+
309
+ <div class="Swift">
310
+ <p class="aside-title">Swift</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
+
313
+ </div>
314
+ </div>
315
+ <div class="parameters">
316
+ <h4>Parameters</h4>
317
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
318
+ <tbody>
319
+ <tr>
320
+ <td scope="row">
321
+ <code>
322
+ <em class="term">options</em>
323
+ </code>
324
+ </td>
325
+ <td>
326
+ <div class="definition">
327
+ <p class="para">The property list reading options. <code>0</code> by default.</p>
328
+ </div>
329
+ </td>
330
+ </tr>
331
+ <tr>
332
+ <td scope="row">
333
+ <code>
334
+ <em class="term">completionHandler</em>
335
+ </code>
336
+ </td>
337
+ <td>
338
+ <div class="definition">
339
+ <p class="para">A closure to be executed once the request has finished. The closure takes 4 arguments: the URL request, the URL response, if one was received, the property list, if one could be created from the URL response and data, and any error produced while creating the property list.</p>
340
+ </div>
341
+ </td>
342
+ </tr>
343
+ </tbody>
344
+ </table>
345
+ </div>
346
+ <div class="result-description">
347
+ <h4>Return Value</h4>
348
+ <p class="para">The request.</p>
349
+ </div>
350
+ <div class="result-description view-on-github">
351
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L1433">Show on GitHub</a>
352
+ </div>
353
+ </section>
354
+ </div>
355
+ </li>
356
+ </ul>
357
+ </div>
358
+ </section>
359
+ </section>
360
+ <section id="footer">
361
+ <p class="copyright">&copy; YYYY <a class="link" href="https://nshipster.com/alamofire" target="_blank" rel="external">Alamofire</a>. All rights reserved. (Last updated: YYYY-MM-DD)</p>
362
+ <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>
363
+ </section>
364
+ </article>
365
+ </div>
366
+ </body>
367
+ </div>
368
+ </html>