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
@@ -0,0 +1,257 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <title>Enums 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="Enums Reference"></a>
24
+ <header>
25
+ <div class="content-wrapper">
26
+ <p class="header-text"><a href="index.html">Alamofire Docs</a> (40% documented)</p>
27
+ <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>
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">Alamofire Reference</a>
34
+ <img id="carat" src="img/carat.png" height="10px" width="6px" />
35
+ Enums 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/Manager.html">Manager</a>
47
+ </li>
48
+ <li class="nav-chapter">
49
+ <a href="Classes/Request.html">Request</a>
50
+ </li>
51
+ </ul>
52
+ </li>
53
+ <li class="part-name tasks">
54
+ <a href="Global Variables.html">Global Variables</a>
55
+ <ul class="nav-chapters">
56
+ <li class="nav-chapter">
57
+ <a href="Global Variables.html#/s:v9Alamofire20AlamofireErrorDomainSS">AlamofireErrorDomain</a>
58
+ </li>
59
+ </ul>
60
+ </li>
61
+ <li class="part-name tasks">
62
+ <a href="Enums.html">Enums</a>
63
+ <ul class="nav-chapters">
64
+ <li class="nav-chapter">
65
+ <a href="Enums.html#/s:O9Alamofire6Method">Method</a>
66
+ </li>
67
+ <li class="nav-chapter">
68
+ <a href="Enums/ParameterEncoding.html">ParameterEncoding</a>
69
+ </li>
70
+ </ul>
71
+ </li>
72
+ <li class="part-name tasks">
73
+ <a href="Extensions.html">Extensions</a>
74
+ <ul class="nav-chapters">
75
+ <li class="nav-chapter">
76
+ <a href="Extensions.html#/s:SS">String</a>
77
+ </li>
78
+ <li class="nav-chapter">
79
+ <a href="Extensions.html#/c:objc(cs)NSURLRequest">NSURLRequest</a>
80
+ </li>
81
+ <li class="nav-chapter">
82
+ <a href="Extensions.html#/c:objc(cs)NSURLRequest">NSURLRequest</a>
83
+ </li>
84
+ <li class="nav-chapter">
85
+ <a href="Extensions/Request.html">Request</a>
86
+ </li>
87
+ <li class="nav-chapter">
88
+ <a href="Extensions/Manager.html">Manager</a>
89
+ </li>
90
+ <li class="nav-chapter">
91
+ <a href="Extensions.html#/s:C9Alamofire7Request">Request</a>
92
+ </li>
93
+ <li class="nav-chapter">
94
+ <a href="Extensions/Manager.html">Manager</a>
95
+ </li>
96
+ <li class="nav-chapter">
97
+ <a href="Extensions/Request.html">Request</a>
98
+ </li>
99
+ <li class="nav-chapter">
100
+ <a href="Extensions/Request.html">Request</a>
101
+ </li>
102
+ <li class="nav-chapter">
103
+ <a href="Extensions/Request.html">Request</a>
104
+ </li>
105
+ <li class="nav-chapter">
106
+ <a href="Extensions/Request.html">Request</a>
107
+ </li>
108
+ <li class="nav-chapter">
109
+ <a href="Extensions/Request.html">Request</a>
110
+ </li>
111
+ <li class="nav-chapter">
112
+ <a href="Extensions/Request.html">Request</a>
113
+ </li>
114
+ </ul>
115
+ </li>
116
+ <li class="part-name tasks">
117
+ <a href="Functions.html">Functions</a>
118
+ <ul class="nav-chapters">
119
+ <li class="nav-chapter">
120
+ <a href="Functions.html#/s:F9Alamofire7requestFTOS_6MethodPS_20URLStringConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject___8encodingOS_17ParameterEncoding_CS_7Request">request(_:_:parameters:encoding:)</a>
121
+ </li>
122
+ <li class="nav-chapter">
123
+ <a href="Functions.html#/s:F9Alamofire7requestFPS_21URLRequestConvertible_CS_7Request">request(_:)</a>
124
+ </li>
125
+ <li class="nav-chapter">
126
+ <a href="Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo5NSURL_CS_7Request">upload(_:_:_:)</a>
127
+ </li>
128
+ <li class="nav-chapter">
129
+ <a href="Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo5NSURL_CS_7Request">upload(_:_:)</a>
130
+ </li>
131
+ <li class="nav-chapter">
132
+ <a href="Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo6NSData_CS_7Request">upload(_:_:_:)</a>
133
+ </li>
134
+ <li class="nav-chapter">
135
+ <a href="Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo6NSData_CS_7Request">upload(_:_:)</a>
136
+ </li>
137
+ <li class="nav-chapter">
138
+ <a href="Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:_:)</a>
139
+ </li>
140
+ <li class="nav-chapter">
141
+ <a href="Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:)</a>
142
+ </li>
143
+ <li class="nav-chapter">
144
+ <a href="Functions.html#/s:F9Alamofire8downloadFTOS_6MethodPS_20URLStringConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request">download(_:_:_:)</a>
145
+ </li>
146
+ <li class="nav-chapter">
147
+ <a href="Functions.html#/s:F9Alamofire8downloadFTPS_21URLRequestConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(_:_:)</a>
148
+ </li>
149
+ <li class="nav-chapter">
150
+ <a href="Functions.html#/s:F9Alamofire8downloadFT10resumeDataCSo6NSDataFTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(resumeData:_:)</a>
151
+ </li>
152
+ </ul>
153
+ </li>
154
+ <li class="part-name tasks">
155
+ <a href="Protocols.html">Protocols</a>
156
+ <ul class="nav-chapters">
157
+ <li class="nav-chapter">
158
+ <a href="Protocols/URLStringConvertible.html">URLStringConvertible</a>
159
+ </li>
160
+ <li class="nav-chapter">
161
+ <a href="Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
162
+ </li>
163
+ </ul>
164
+ </li>
165
+ </ul>
166
+ </nav>
167
+ <div class="pixel-line"></div>
168
+ <div class="rubber-band-gap"></div>
169
+ <article class="chapter">
170
+ <a name="/"></a>
171
+ <h1 class="chapter-name">Enums</h1>
172
+ <section>
173
+ <section class="section">
174
+ <p class="para">The following enums are available globally.</p>
175
+ </section>
176
+ <section class="section task-group-section">
177
+ <div class="task-group">
178
+ <div class="task-name-container">
179
+
180
+ <a name="/Unnamed"></a>
181
+
182
+ </div>
183
+ <ul class="task-group-list">
184
+ <li class="item symbol">
185
+ <div class="task-group-term">
186
+ <code>
187
+ <a name="/s:O9Alamofire6Method">
188
+ <a name="//apple_ref/swift/Enum/Method" class="dashAnchor"></a>
189
+ <a class="x-instance-method Swift" href="#/s:O9Alamofire6Method">Method</a>
190
+ </code>
191
+ </div>
192
+ <div class="height-container">
193
+ <div class="pointy-thing-container"></div>
194
+ <section class="section instance-method">
195
+ <div class="pointy-thing"></div>
196
+ <div class="abstract">
197
+ <p class="para">HTTP method definitions.See <a href="http://tools.ietf.org/html/rfc7231#section-4.3">http://tools.ietf.org/html/rfc7231#section-4.3</a></p>
198
+ </div>
199
+ <div class="declaration">
200
+ <h4>Declaration</h4>
201
+
202
+ <div class="Swift">
203
+ <p class="aside-title">Swift</p>
204
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">Method</span> <span class="p">:</span> <span class="kt">String</span></code></pre>
205
+
206
+ </div>
207
+ </div>
208
+ <div class="result-description view-on-github">
209
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L33">Show on GitHub</a>
210
+ </div>
211
+ </section>
212
+ </div>
213
+ </li>
214
+ <li class="item symbol">
215
+ <div class="task-group-term">
216
+ <code>
217
+ <a name="/s:O9Alamofire17ParameterEncoding">
218
+ <a name="//apple_ref/swift/Enum/ParameterEncoding" class="dashAnchor"></a>
219
+ <a class="x-instance-method Swift" href="#/s:O9Alamofire17ParameterEncoding">ParameterEncoding</a>
220
+ </code>
221
+ </div>
222
+ <div class="height-container">
223
+ <div class="pointy-thing-container"></div>
224
+ <section class="section instance-method">
225
+ <div class="pointy-thing"></div>
226
+ <div class="abstract">
227
+ <p class="para">Used to specify the way in which a set of parameters are applied to a URL request.</p>
228
+ <a href="Enums/ParameterEncoding.html" class="see-more">See more</a>
229
+ </div>
230
+ <div class="declaration">
231
+ <h4>Declaration</h4>
232
+
233
+ <div class="Swift">
234
+ <p class="aside-title">Swift</p>
235
+ <pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">ParameterEncoding</span></code></pre>
236
+
237
+ </div>
238
+ </div>
239
+ <div class="result-description view-on-github">
240
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L48">Show on GitHub</a>
241
+ </div>
242
+ </section>
243
+ </div>
244
+ </li>
245
+ </ul>
246
+ </div>
247
+ </section>
248
+ </section>
249
+ <section id="footer">
250
+ <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>
251
+ <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>
252
+ </section>
253
+ </article>
254
+ </div>
255
+ </body>
256
+ </div>
257
+ </html>
@@ -0,0 +1,346 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <title>ParameterEncoding Enum 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/Enum/ParameterEncoding" class="dashAnchor"></a>
24
+ <a title="ParameterEncoding Enum 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
+ ParameterEncoding Enum 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">ParameterEncoding</h1>
173
+ <section>
174
+ <section class="section">
175
+ <p class="para">Used to specify the way in which a set of parameters are applied to a URL request.</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:FO9Alamofire17ParameterEncoding6encodeFS0_FTPS_21URLRequestConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject____TCSo12NSURLRequestGSqCSo7NSError__">
189
+ <a name="//apple_ref/swift/Method/encode(_:parameters:)" class="dashAnchor"></a>
190
+ <a class="x-instance-method Swift" href="#/s:FO9Alamofire17ParameterEncoding6encodeFS0_FTPS_21URLRequestConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject____TCSo12NSURLRequestGSqCSo7NSError__">encode(_:parameters:)</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 URL request by encoding parameters and applying them onto an existing request.</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">func</span> <span class="nf">encode</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">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">-&gt;</span> <span class="p">(</span><span class="kt">NSURLRequest</span><span class="p">,</span> <span class="kt">NSError</span><span class="p">?)</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">URLRequest</em>
217
+ </code>
218
+ </td>
219
+ <td>
220
+ <div class="definition">
221
+ <p class="para">The request to have parameters applied</p>
222
+ </div>
223
+ </td>
224
+ </tr>
225
+ <tr>
226
+ <td scope="row">
227
+ <code>
228
+ <em class="term">parameters</em>
229
+ </code>
230
+ </td>
231
+ <td>
232
+ <div class="definition">
233
+ <p class="para">The parameters to apply</p>
234
+ </div>
235
+ </td>
236
+ </tr>
237
+ </tbody>
238
+ </table>
239
+ </div>
240
+ <div class="result-description">
241
+ <h4>Return Value</h4>
242
+ <p class="para">A tuple containing the constructed request and the error that occurred during parameter encoding, if any.</p>
243
+ </div>
244
+ <div class="result-description view-on-github">
245
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L77">Show on GitHub</a>
246
+ </div>
247
+ </section>
248
+ </div>
249
+ </li>
250
+ <li class="item symbol">
251
+ <div class="task-group-term">
252
+ <code>
253
+ <a name="/s:FO9Alamofire17ParameterEncoding6CustomFMS0_FFTPS_21URLRequestConvertible_GSqGVSs10DictionarySSPSs9AnyObject____TCSo12NSURLRequestGSqCSo7NSError__S0_">
254
+ <a name="//apple_ref/swift/Element/Custom" class="dashAnchor"></a>
255
+ <a class="x-instance-method Swift" href="#/s:FO9Alamofire17ParameterEncoding6CustomFMS0_FFTPS_21URLRequestConvertible_GSqGVSs10DictionarySSPSs9AnyObject____TCSo12NSURLRequestGSqCSo7NSError__S0_">Custom</a>
256
+ </code>
257
+ </div>
258
+ <div class="height-container">
259
+ <div class="pointy-thing-container"></div>
260
+ <section class="section instance-method">
261
+ <div class="pointy-thing"></div>
262
+ <div class="abstract">
263
+ <p class="para">Uses the associated closure value to construct a new request given an existing request and parameters.</p>
264
+ </div>
265
+ <div class="result-description view-on-github">
266
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L67">Show on GitHub</a>
267
+ </div>
268
+ </section>
269
+ </div>
270
+ </li>
271
+ <li class="item symbol">
272
+ <div class="task-group-term">
273
+ <code>
274
+ <a name="/s:FO9Alamofire17ParameterEncoding3URLFMS0_S0_">
275
+ <a name="//apple_ref/swift/Element/URL" class="dashAnchor"></a>
276
+ <a class="x-instance-method Swift" href="#/s:FO9Alamofire17ParameterEncoding3URLFMS0_S0_">URL</a>
277
+ </code>
278
+ </div>
279
+ <div class="height-container">
280
+ <div class="pointy-thing-container"></div>
281
+ <section class="section instance-method">
282
+ <div class="pointy-thing"></div>
283
+ <div class="abstract">
284
+ <p class="para">A query string to be set as or appended to any existing URL query for <code>GET</code>, <code>HEAD</code>, and <code>DELETE</code> requests, or set as the body for requests with any other HTTP method. The <code>Content-Type</code> HTTP header field of an encoded request with HTTP body is set to <code>application/x-www-form-urlencoded</code>. Since there is no published specification for how to encode collection types, the convention of appending <code>[]</code> to the key for array values (<code>foo[]=1&amp;foo[]=2</code>), and appending the key surrounded by square brackets for nested dictionary values (<code>foo[bar]=baz</code>).</p>
285
+ </div>
286
+ <div class="result-description view-on-github">
287
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L52">Show on GitHub</a>
288
+ </div>
289
+ </section>
290
+ </div>
291
+ </li>
292
+ <li class="item symbol">
293
+ <div class="task-group-term">
294
+ <code>
295
+ <a name="/s:FO9Alamofire17ParameterEncoding4JSONFMS0_S0_">
296
+ <a name="//apple_ref/swift/Element/JSON" class="dashAnchor"></a>
297
+ <a class="x-instance-method Swift" href="#/s:FO9Alamofire17ParameterEncoding4JSONFMS0_S0_">JSON</a>
298
+ </code>
299
+ </div>
300
+ <div class="height-container">
301
+ <div class="pointy-thing-container"></div>
302
+ <section class="section instance-method">
303
+ <div class="pointy-thing"></div>
304
+ <div class="abstract">
305
+ <p class="para">Uses <code>NSJSONSerialization</code> to create a JSON representation of the parameters object, which is set as the body of the request. The <code>Content-Type</code> HTTP header field of an encoded request is set to <code>application/json</code>.</p>
306
+ </div>
307
+ <div class="result-description view-on-github">
308
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L57">Show on GitHub</a>
309
+ </div>
310
+ </section>
311
+ </div>
312
+ </li>
313
+ <li class="item symbol">
314
+ <div class="task-group-term">
315
+ <code>
316
+ <a name="/s:FO9Alamofire17ParameterEncoding12PropertyListFMS0_FTOSC20NSPropertyListFormatSi_S0_">
317
+ <a name="//apple_ref/swift/Element/PropertyList" class="dashAnchor"></a>
318
+ <a class="x-instance-method Swift" href="#/s:FO9Alamofire17ParameterEncoding12PropertyListFMS0_FTOSC20NSPropertyListFormatSi_S0_">PropertyList</a>
319
+ </code>
320
+ </div>
321
+ <div class="height-container">
322
+ <div class="pointy-thing-container"></div>
323
+ <section class="section instance-method">
324
+ <div class="pointy-thing"></div>
325
+ <div class="abstract">
326
+ <p class="para">Uses <code>NSPropertyListSerialization</code> to create a plist representation of the parameters object, according to the associated format and write options values, which is set as the body of the request. The <code>Content-Type</code> HTTP header field of an encoded request is set to <code>application/x-plist</code>.</p>
327
+ </div>
328
+ <div class="result-description view-on-github">
329
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L62">Show on GitHub</a>
330
+ </div>
331
+ </section>
332
+ </div>
333
+ </li>
334
+ </ul>
335
+ </div>
336
+ </section>
337
+ </section>
338
+ <section id="footer">
339
+ <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>
340
+ <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>
341
+ </section>
342
+ </article>
343
+ </div>
344
+ </body>
345
+ </div>
346
+ </html>