jazzy 0.0.4 → 0.0.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (156) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +2 -2
  3. data/.gitmodules +3 -0
  4. data/.rubocop.yml +67 -0
  5. data/.rubocop_todo.yml +16 -0
  6. data/.travis.yml +6 -0
  7. data/Gemfile +15 -7
  8. data/Gemfile.lock +62 -12
  9. data/LICENSE +0 -0
  10. data/README.md +39 -12
  11. data/Rakefile +87 -1
  12. data/bin/jazzy +10 -44
  13. data/bin/sourcekitten +0 -0
  14. data/jazzy.gemspec +16 -16
  15. data/lib/jazzy.rb +1 -159
  16. data/lib/jazzy/assets/css/jazzy.css +561 -0
  17. data/lib/{assets/Images/carat_2x.png → jazzy/assets/img/carat.png} +0 -0
  18. data/lib/jazzy/assets/img/dash.png +0 -0
  19. data/lib/jazzy/assets/img/gh.png +0 -0
  20. data/lib/jazzy/assets/js/jazzy.js +15 -0
  21. data/lib/jazzy/assets/js/jquery.min.js +4 -0
  22. data/lib/jazzy/config.rb +100 -0
  23. data/lib/jazzy/doc.mustache +46 -0
  24. data/lib/jazzy/doc.rb +23 -0
  25. data/lib/jazzy/doc_builder.rb +166 -0
  26. data/lib/jazzy/gem_version.rb +3 -0
  27. data/lib/jazzy/jazzy_markdown.rb +13 -0
  28. data/lib/jazzy/partials/footer.mustache +4 -0
  29. data/lib/jazzy/partials/nav.mustache +16 -0
  30. data/lib/jazzy/partials/parameter.mustache +12 -0
  31. data/lib/jazzy/partials/task.mustache +66 -0
  32. data/lib/jazzy/partials/tasks.mustache +7 -0
  33. data/lib/jazzy/source_declaration.rb +19 -0
  34. data/lib/jazzy/sourcekitten.rb +146 -0
  35. data/lib/jazzy/xml_helper.rb +15 -0
  36. data/screenshot.jpg +0 -0
  37. data/spec/.gitkeep +0 -0
  38. data/spec/integration_spec.rb +89 -0
  39. data/spec/integration_specs/document_alamofire/after/docs/Classes.html +266 -0
  40. data/spec/integration_specs/document_alamofire/after/docs/Classes/Manager.html +677 -0
  41. data/spec/integration_specs/document_alamofire/after/docs/Classes/Manager/SessionDelegate.html +866 -0
  42. data/spec/integration_specs/document_alamofire/after/docs/Classes/Manager/Singleton.html +246 -0
  43. data/spec/integration_specs/document_alamofire/after/docs/Classes/Request.html +1376 -0
  44. data/spec/integration_specs/document_alamofire/after/docs/Classes/Request/DataTaskDelegate.html +486 -0
  45. data/spec/integration_specs/document_alamofire/after/docs/Classes/Request/TaskDelegate.html +506 -0
  46. data/spec/integration_specs/document_alamofire/after/docs/Enums.html +266 -0
  47. data/spec/integration_specs/document_alamofire/after/docs/Enums/ParameterEncoding.html +391 -0
  48. data/spec/integration_specs/document_alamofire/after/docs/Extensions.html +641 -0
  49. data/spec/integration_specs/document_alamofire/after/docs/Extensions/Manager.html +376 -0
  50. data/spec/integration_specs/document_alamofire/after/docs/Extensions/NSURL.html +226 -0
  51. data/spec/integration_specs/document_alamofire/after/docs/Extensions/NSURLComponents.html +226 -0
  52. data/spec/integration_specs/document_alamofire/after/docs/Extensions/NSURLRequest.html +226 -0
  53. data/spec/integration_specs/document_alamofire/after/docs/Extensions/Request.html +377 -0
  54. data/spec/integration_specs/document_alamofire/after/docs/Extensions/Request/DownloadTaskDelegate.html +406 -0
  55. data/spec/integration_specs/document_alamofire/after/docs/Extensions/Request/MIMEType.html +286 -0
  56. data/spec/integration_specs/document_alamofire/after/docs/Extensions/Request/UploadTaskDelegate.html +266 -0
  57. data/spec/integration_specs/document_alamofire/after/docs/Extensions/String.html +226 -0
  58. data/spec/integration_specs/document_alamofire/after/docs/Functions.html +1001 -0
  59. data/spec/integration_specs/document_alamofire/after/docs/Global Variables.html +236 -0
  60. data/spec/integration_specs/document_alamofire/after/docs/Protocols.html +266 -0
  61. data/spec/integration_specs/document_alamofire/after/docs/Protocols/URLRequestConvertible.html +236 -0
  62. data/spec/integration_specs/document_alamofire/after/docs/Protocols/URLStringConvertible.html +236 -0
  63. data/spec/integration_specs/document_alamofire/after/docs/Typealiases.html +266 -0
  64. data/spec/integration_specs/document_alamofire/after/docs/css/jazzy.css +561 -0
  65. data/spec/integration_specs/document_alamofire/after/docs/img/carat.png +0 -0
  66. data/spec/integration_specs/document_alamofire/after/docs/img/dash.png +0 -0
  67. data/spec/integration_specs/document_alamofire/after/docs/img/gh.png +0 -0
  68. data/spec/integration_specs/document_alamofire/after/docs/index.html +194 -0
  69. data/spec/integration_specs/document_alamofire/after/docs/js/jazzy.js +15 -0
  70. data/spec/integration_specs/document_alamofire/after/docs/js/jquery.min.js +4 -0
  71. data/spec/integration_specs/document_alamofire/after/execution_output.txt +2 -0
  72. data/spec/integration_specs/misc_jazzy_features/after/docs/Classes.html +317 -0
  73. data/spec/integration_specs/misc_jazzy_features/after/docs/Classes/ImplicitlyInternalTopLevelClass.html +138 -0
  74. data/spec/integration_specs/misc_jazzy_features/after/docs/Enums.html +155 -0
  75. data/spec/integration_specs/misc_jazzy_features/after/docs/Enums/DocumentedEnum.html +128 -0
  76. data/spec/integration_specs/misc_jazzy_features/after/docs/Global Variables.html +138 -0
  77. data/spec/integration_specs/misc_jazzy_features/after/docs/css/jazzy.css +561 -0
  78. data/spec/integration_specs/misc_jazzy_features/after/docs/img/carat.png +0 -0
  79. data/spec/integration_specs/misc_jazzy_features/after/docs/img/dash.png +0 -0
  80. data/spec/integration_specs/misc_jazzy_features/after/docs/img/gh.png +0 -0
  81. data/spec/integration_specs/misc_jazzy_features/after/docs/index.html +99 -0
  82. data/spec/integration_specs/misc_jazzy_features/after/docs/js/jazzy.js +15 -0
  83. data/spec/integration_specs/misc_jazzy_features/after/docs/js/jquery.min.js +4 -0
  84. data/spec/integration_specs/misc_jazzy_features/after/execution_output.txt +2 -0
  85. data/spec/integration_specs/misc_jazzy_features/before/MiscJazzyFeatures.xcodeproj/project.pbxproj +293 -0
  86. data/{parser/ASTDump.xcodeproj → spec/integration_specs/misc_jazzy_features/before/MiscJazzyFeatures.xcodeproj}/project.xcworkspace/contents.xcworkspacedata +1 -1
  87. data/spec/integration_specs/misc_jazzy_features/before/MiscJazzyFeatures/Classes.swift +60 -0
  88. data/spec/integration_specs/misc_jazzy_features/before/MiscJazzyFeatures/Info.plist +28 -0
  89. data/spec/integration_specs/misc_jazzy_features/before/MiscJazzyFeatures/MiscJazzyFeatures.h +10 -0
  90. data/spec/integration_specs/misc_jazzy_features/before/docs/Classes.html +317 -0
  91. data/spec/integration_specs/misc_jazzy_features/before/docs/Classes/ImplicitlyInternalTopLevelClass.html +138 -0
  92. data/spec/integration_specs/misc_jazzy_features/before/docs/Enums.html +155 -0
  93. data/spec/integration_specs/misc_jazzy_features/before/docs/Enums/DocumentedEnum.html +128 -0
  94. data/spec/integration_specs/misc_jazzy_features/before/docs/Global Variables.html +138 -0
  95. data/spec/integration_specs/misc_jazzy_features/before/docs/css/jazzy.css +561 -0
  96. data/spec/integration_specs/misc_jazzy_features/before/docs/img/carat.png +0 -0
  97. data/spec/integration_specs/misc_jazzy_features/before/docs/img/dash.png +0 -0
  98. data/spec/integration_specs/misc_jazzy_features/before/docs/img/gh.png +0 -0
  99. data/spec/integration_specs/misc_jazzy_features/before/docs/index.html +99 -0
  100. data/spec/integration_specs/misc_jazzy_features/before/docs/js/jazzy.js +15 -0
  101. data/spec/integration_specs/misc_jazzy_features/before/docs/js/jquery.min.js +4 -0
  102. metadata +112 -76
  103. data/DEV_README.md +0 -35
  104. data/bin/ASTDump +0 -0
  105. data/bin/generate_swift_header.sh +0 -14
  106. data/lib/assets/CSS/style-1.1.15.css +0 -3366
  107. data/lib/assets/Images/apple2.png +0 -0
  108. data/lib/assets/Images/check.png +0 -0
  109. data/lib/assets/Images/class_node_parent_and_child_2x.png +0 -0
  110. data/lib/assets/Images/class_node_subclass_last_child_2x.png +0 -0
  111. data/lib/assets/Images/class_node_subclass_with_siblings_2x.png +0 -0
  112. data/lib/assets/Images/closebox_2x.png +0 -0
  113. data/lib/assets/Images/collection_last_child_2x.png +0 -0
  114. data/lib/assets/Images/collection_last_child_orphan_grandparent_2x.png +0 -0
  115. data/lib/assets/Images/collection_last_child_orphan_parent_2x.png +0 -0
  116. data/lib/assets/Images/collection_last_child_orphan_parent_and_grandparent_2x.png +0 -0
  117. data/lib/assets/Images/collection_node_2x.png +0 -0
  118. data/lib/assets/Images/collection_node_orphan_grandparent_2x.png +0 -0
  119. data/lib/assets/Images/collection_node_orphan_parent_2x.png +0 -0
  120. data/lib/assets/Images/collection_node_orphan_parent_and_grandparent_2x.png +0 -0
  121. data/lib/assets/Images/collection_node_parent_2x.png +0 -0
  122. data/lib/assets/Images/collection_node_parent_last_child_orphan_parent_2x.png +0 -0
  123. data/lib/assets/Images/collection_node_parent_orphan_parent_2x.png +0 -0
  124. data/lib/assets/Images/collection_parent_last_child_2x.png +0 -0
  125. data/lib/assets/Images/download_2x.png +0 -0
  126. data/lib/assets/Images/left_arrow_2x.png +0 -0
  127. data/lib/assets/Images/magnify_2x.png +0 -0
  128. data/lib/assets/Images/minus_2x.png +0 -0
  129. data/lib/assets/Images/playbutton.svg +0 -15
  130. data/lib/assets/Images/plus_2x.png +0 -0
  131. data/lib/assets/Images/right_arrow_2x.png +0 -0
  132. data/lib/assets/Images/search_2x.png +0 -0
  133. data/lib/assets/Images/shortstack_2x.png +0 -0
  134. data/lib/assets/JavaScript/devpubs-1.1.15.js +0 -1293
  135. data/lib/jazzy/jazzhtml.rb +0 -7
  136. data/lib/jazzy/klass.mustache +0 -150
  137. data/lib/jazzy/klass.rb +0 -23
  138. data/lib/jazzy/partials/klass-method.mustache +0 -70
  139. data/lib/jazzy/partials/klass-overview.mustache +0 -6
  140. data/lib/jazzy/partials/klass-property.mustache +0 -41
  141. data/parser/ASTDump.xcodeproj/project.pbxproj +0 -301
  142. data/parser/ASTDump.xcodeproj/project.xcworkspace/xcshareddata/ASTDump.xccheckout +0 -41
  143. data/parser/ASTDump.xcodeproj/project.xcworkspace/xcuserdata/ta.xcuserdatad/UserInterfaceState.xcuserstate +0 -0
  144. data/parser/ASTDump.xcodeproj/xcuserdata/ta.xcuserdatad/xcschemes/ASTDump.xcscheme +0 -86
  145. data/parser/ASTDump.xcodeproj/xcuserdata/ta.xcuserdatad/xcschemes/xcschememanagement.plist +0 -22
  146. data/parser/ASTDump/main.cpp +0 -71
  147. data/parser/clang-c/BuildSystem.h +0 -148
  148. data/parser/clang-c/CXCompilationDatabase.h +0 -170
  149. data/parser/clang-c/CXErrorCode.h +0 -64
  150. data/parser/clang-c/CXString.h +0 -61
  151. data/parser/clang-c/Documentation.h +0 -554
  152. data/parser/clang-c/Index.h +0 -5454
  153. data/parser/clang-c/Platform.h +0 -45
  154. data/sample/JAZMusician.h +0 -38
  155. data/sample/JAZMusician.m +0 -19
  156. data/sample/Musician.swift +0 -37
data/spec/integration_specs/document_alamofire/after/docs/Enums.html ADDED
@@ -0,0 +1,266 @@
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
+ <meta charset='utf-8'>
7
+ <script src="js/jquery.min.js" defer></script>
8
+ <script src="js/jazzy.js" defer></script>
9
+ </head>
10
+ <body id="reference" class="Swift">
11
+ <a title="Enums Reference"></a>
12
+ <header>
13
+ <div class="content-wrapper">
14
+ <p class="header-text"><a href="#">Alamofire Docs</a></p>
15
+ <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>
16
+ <p id="header-links"><a href=""><img id="header-icon" src="img/dash.png" height="16px" width="16px" />Install in Dash</a></p>
17
+ </div>
18
+ </header>
19
+ <section id="valence">
20
+ <div class="content-wrapper">
21
+ <p id="hierarchial_navigation">
22
+ <a href="#" id="design_resources_link">Alamofire Reference</a>
23
+ <img id="carat" src="img/carat.png" height="10px" width="6px" />
24
+ Enums Reference
25
+ </p>
26
+ </div>
27
+ </section>
28
+ <div class="content-wrapper">
29
+ <nav class="book-parts">
30
+ <ul class="nav-parts">
31
+ <li class="part-name tasks">
32
+ <a href="Classes.html">Classes</a>
33
+ <ul class="nav-chapters">
34
+ <li class="nav-chapter">
35
+ <a href="Classes/Manager.html">Manager</a>
36
+ </li>
37
+ <li class="nav-chapter">
38
+ <a href="Classes/Request.html">Request</a>
39
+ </li>
40
+ </ul>
41
+ </li>
42
+ <li class="part-name tasks">
43
+ <a href="Global Variables.html">Global Variables</a>
44
+ <ul class="nav-chapters">
45
+ <li class="nav-chapter">
46
+ <a href="Global Variables.html#/s:v9Alamofire20AlamofireErrorDomainSS">AlamofireErrorDomain</a>
47
+ </li>
48
+ </ul>
49
+ </li>
50
+ <li class="part-name tasks">
51
+ <a href="Enums.html">Enums</a>
52
+ <ul class="nav-chapters">
53
+ <li class="nav-chapter">
54
+ <a href="Enums.html#/s:O9Alamofire6Method">Method</a>
55
+ </li>
56
+ <li class="nav-chapter">
57
+ <a href="Enums/ParameterEncoding.html">ParameterEncoding</a>
58
+ </li>
59
+ </ul>
60
+ </li>
61
+ <li class="part-name tasks">
62
+ <a href="Extensions.html">Extensions</a>
63
+ <ul class="nav-chapters">
64
+ <li class="nav-chapter">
65
+ <a href="Extensions/String.html">String</a>
66
+ </li>
67
+ <li class="nav-chapter">
68
+ <a href="Extensions/NSURL.html">NSURL</a>
69
+ </li>
70
+ <li class="nav-chapter">
71
+ <a href="Extensions/NSURLComponents.html">NSURLComponents</a>
72
+ </li>
73
+ <li class="nav-chapter">
74
+ <a href="Extensions/NSURLRequest.html">NSURLRequest</a>
75
+ </li>
76
+ <li class="nav-chapter">
77
+ <a href="Extensions/NSURLRequest.html">NSURLRequest</a>
78
+ </li>
79
+ <li class="nav-chapter">
80
+ <a href="Extensions/Request.html">Request</a>
81
+ </li>
82
+ <li class="nav-chapter">
83
+ <a href="Extensions/Manager.html">Manager</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/Request.html">Request</a>
93
+ </li>
94
+ <li class="nav-chapter">
95
+ <a href="Extensions/Request.html">Request</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
+ </ul>
110
+ </li>
111
+ <li class="part-name tasks">
112
+ <a href="Functions.html">Functions</a>
113
+ <ul class="nav-chapters">
114
+ <li class="nav-chapter">
115
+ <a href="Functions.html#/s:F9AlamofireP33_A313450CFC1FC3D0CBEF4411412DB9E810URLRequestFTOS_6MethodPS_20URLStringConvertible__CSo12NSURLRequest">URLRequest(_:_:)</a>
116
+ </li>
117
+ <li class="nav-chapter">
118
+ <a href="Functions.html#/s:F9Alamofire7requestFTOS_6MethodPS_20URLStringConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject___8encodingOS_17ParameterEncoding_CS_7Request">request(_:_:parameters:encoding:)</a>
119
+ </li>
120
+ <li class="nav-chapter">
121
+ <a href="Functions.html#/s:F9Alamofire7requestFPS_21URLRequestConvertible_CS_7Request">request(_:)</a>
122
+ </li>
123
+ <li class="nav-chapter">
124
+ <a href="Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo5NSURL_CS_7Request">upload(_:_:_:)</a>
125
+ </li>
126
+ <li class="nav-chapter">
127
+ <a href="Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo5NSURL_CS_7Request">upload(_:_:)</a>
128
+ </li>
129
+ <li class="nav-chapter">
130
+ <a href="Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo6NSData_CS_7Request">upload(_:_:_:)</a>
131
+ </li>
132
+ <li class="nav-chapter">
133
+ <a href="Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo6NSData_CS_7Request">upload(_:_:)</a>
134
+ </li>
135
+ <li class="nav-chapter">
136
+ <a href="Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:_:)</a>
137
+ </li>
138
+ <li class="nav-chapter">
139
+ <a href="Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:)</a>
140
+ </li>
141
+ <li class="nav-chapter">
142
+ <a href="Functions.html#/s:F9Alamofire8downloadFTOS_6MethodPS_20URLStringConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request">download(_:_:_:)</a>
143
+ </li>
144
+ <li class="nav-chapter">
145
+ <a href="Functions.html#/s:F9Alamofire8downloadFTPS_21URLRequestConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(_:_:)</a>
146
+ </li>
147
+ <li class="nav-chapter">
148
+ <a href="Functions.html#/s:F9Alamofire8downloadFT10resumeDataCSo6NSDataFTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(resumeData:_:)</a>
149
+ </li>
150
+ </ul>
151
+ </li>
152
+ <li class="part-name tasks">
153
+ <a href="Protocols.html">Protocols</a>
154
+ <ul class="nav-chapters">
155
+ <li class="nav-chapter">
156
+ <a href="Protocols/URLStringConvertible.html">URLStringConvertible</a>
157
+ </li>
158
+ <li class="nav-chapter">
159
+ <a href="Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
160
+ </li>
161
+ </ul>
162
+ </li>
163
+ <li class="part-name tasks">
164
+ <a href="Typealiases.html">Typealiases</a>
165
+ <ul class="nav-chapters">
166
+ <li class="nav-chapter">
167
+ <a href="Typealiases.html#/s:C9Alamofire7Request10Validation">Validation</a>
168
+ </li>
169
+ <li class="nav-chapter">
170
+ <a href="Typealiases.html#/s:C9Alamofire7Request23DownloadFileDestination">DownloadFileDestination</a>
171
+ </li>
172
+ </ul>
173
+ </li>
174
+ </ul>
175
+ </nav>
176
+ <div class="pixel-line"></div>
177
+ <div class="rubber-band-gap"></div>
178
+ <article class="chapter">
179
+ <a name="/"></a>
180
+ <h1 class="chapter-name">Enums</h1>
181
+ <section>
182
+ <section class="section">
183
+ <p class="para">The following enums are available globally.</p>
184
+ </section>
185
+ <section class="section task-group-section">
186
+ <div class="task-group">
187
+ <div class="task-name-container">
188
+ <a name="/Children"></a>
189
+ <a href="#/Children">
190
+ <h3 class="section-name"></h3>
191
+ </a>
192
+ </div>
193
+ <ul class="task-group-list">
194
+ <li class="item symbol">
195
+ <div class="task-group-term">
196
+ <code>
197
+ <a name="/s:O9Alamofire6Method">
198
+ <a class="x-instance-method Swift" href="#/s:O9Alamofire6Method">Method</a>
199
+ </code>
200
+ </div>
201
+ <div class="height-container">
202
+ <div class="pointy-thing-container"></div>
203
+ <section class="section instance-method">
204
+ <div class="pointy-thing"></div>
205
+ <div class="abstract">
206
+ <p class="para">HTTP method definitions.See http://tools.ietf.org/html/rfc7231#section-4.3</p>
207
+ </div>
208
+ <div class="declaration">
209
+ <h4>Declaration</h4>
210
+
211
+ <div class="Swift">
212
+ <p class="aside-title">Swift</p>
213
+ <p class="para">
214
+ <code>public enum Method : String</code>
215
+ </p>
216
+ </div>
217
+ </div>
218
+ <div class="result-description view-on-github">
219
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L33">Show on GitHub</a>
220
+ </div>
221
+ </section>
222
+ </div>
223
+ </li>
224
+ <li class="item symbol">
225
+ <div class="task-group-term">
226
+ <code>
227
+ <a name="/s:O9Alamofire17ParameterEncoding">
228
+ <a class="x-instance-method Swift" href="#/s:O9Alamofire17ParameterEncoding">ParameterEncoding</a>
229
+ </code>
230
+ </div>
231
+ <div class="height-container">
232
+ <div class="pointy-thing-container"></div>
233
+ <section class="section instance-method">
234
+ <div class="pointy-thing"></div>
235
+ <div class="abstract">
236
+ <p class="para">Used to specify the way in which a set of parameters are applied to a URL request.</p>
237
+ </div>
238
+ <div class="declaration">
239
+ <h4>Declaration</h4>
240
+
241
+ <div class="Swift">
242
+ <p class="aside-title">Swift</p>
243
+ <p class="para">
244
+ <code>public enum ParameterEncoding</code>
245
+ </p>
246
+ </div>
247
+ </div>
248
+ <div class="result-description view-on-github">
249
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L48">Show on GitHub</a>
250
+ </div>
251
+ </section>
252
+ </div>
253
+ </li>
254
+ </ul>
255
+ </div>
256
+ </section>
257
+ </section>
258
+ <section id="footer">
259
+ <p class="copyright">&copy; 2014 <a class="link" href="https://nshipster.com/alamofire" target="_blank" rel="external">Alamofire</a>. All rights reserved. (Last updated: 2014-01-01)</p>
260
+ <p class="copyright">Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.0.5</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
261
+ </section>
262
+ </article>
263
+ </div>
264
+ </body>
265
+ </div>
266
+ </html>
data/spec/integration_specs/document_alamofire/after/docs/Enums/ParameterEncoding.html ADDED
@@ -0,0 +1,391 @@
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
+ <meta charset='utf-8'>
7
+ <script src="../js/jquery.min.js" defer></script>
8
+ <script src="../js/jazzy.js" defer></script>
9
+ </head>
10
+ <body id="reference" class="Swift">
11
+ <a title="ParameterEncoding Enum Reference"></a>
12
+ <header>
13
+ <div class="content-wrapper">
14
+ <p class="header-text"><a href="#">Alamofire Docs</a></p>
15
+ <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>
16
+ <p id="header-links"><a href=""><img id="header-icon" src="../img/dash.png" height="16px" width="16px" />Install in Dash</a></p>
17
+ </div>
18
+ </header>
19
+ <section id="valence">
20
+ <div class="content-wrapper">
21
+ <p id="hierarchial_navigation">
22
+ <a href="#" id="design_resources_link">Alamofire Reference</a>
23
+ <img id="carat" src="../img/carat.png" height="10px" width="6px" />
24
+ ParameterEncoding Enum Reference
25
+ </p>
26
+ </div>
27
+ </section>
28
+ <div class="content-wrapper">
29
+ <nav class="book-parts">
30
+ <ul class="nav-parts">
31
+ <li class="part-name tasks">
32
+ <a href="../Classes.html">Classes</a>
33
+ <ul class="nav-chapters">
34
+ <li class="nav-chapter">
35
+ <a href="../Classes/Manager.html">Manager</a>
36
+ </li>
37
+ <li class="nav-chapter">
38
+ <a href="../Classes/Request.html">Request</a>
39
+ </li>
40
+ </ul>
41
+ </li>
42
+ <li class="part-name tasks">
43
+ <a href="../Global Variables.html">Global Variables</a>
44
+ <ul class="nav-chapters">
45
+ <li class="nav-chapter">
46
+ <a href="../Global Variables.html#/s:v9Alamofire20AlamofireErrorDomainSS">AlamofireErrorDomain</a>
47
+ </li>
48
+ </ul>
49
+ </li>
50
+ <li class="part-name tasks">
51
+ <a href="../Enums.html">Enums</a>
52
+ <ul class="nav-chapters">
53
+ <li class="nav-chapter">
54
+ <a href="../Enums.html#/s:O9Alamofire6Method">Method</a>
55
+ </li>
56
+ <li class="nav-chapter">
57
+ <a href="../Enums/ParameterEncoding.html">ParameterEncoding</a>
58
+ </li>
59
+ </ul>
60
+ </li>
61
+ <li class="part-name tasks">
62
+ <a href="../Extensions.html">Extensions</a>
63
+ <ul class="nav-chapters">
64
+ <li class="nav-chapter">
65
+ <a href="../Extensions/String.html">String</a>
66
+ </li>
67
+ <li class="nav-chapter">
68
+ <a href="../Extensions/NSURL.html">NSURL</a>
69
+ </li>
70
+ <li class="nav-chapter">
71
+ <a href="../Extensions/NSURLComponents.html">NSURLComponents</a>
72
+ </li>
73
+ <li class="nav-chapter">
74
+ <a href="../Extensions/NSURLRequest.html">NSURLRequest</a>
75
+ </li>
76
+ <li class="nav-chapter">
77
+ <a href="../Extensions/NSURLRequest.html">NSURLRequest</a>
78
+ </li>
79
+ <li class="nav-chapter">
80
+ <a href="../Extensions/Request.html">Request</a>
81
+ </li>
82
+ <li class="nav-chapter">
83
+ <a href="../Extensions/Manager.html">Manager</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/Request.html">Request</a>
93
+ </li>
94
+ <li class="nav-chapter">
95
+ <a href="../Extensions/Request.html">Request</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
+ </ul>
110
+ </li>
111
+ <li class="part-name tasks">
112
+ <a href="../Functions.html">Functions</a>
113
+ <ul class="nav-chapters">
114
+ <li class="nav-chapter">
115
+ <a href="../Functions.html#/s:F9AlamofireP33_A313450CFC1FC3D0CBEF4411412DB9E810URLRequestFTOS_6MethodPS_20URLStringConvertible__CSo12NSURLRequest">URLRequest(_:_:)</a>
116
+ </li>
117
+ <li class="nav-chapter">
118
+ <a href="../Functions.html#/s:F9Alamofire7requestFTOS_6MethodPS_20URLStringConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject___8encodingOS_17ParameterEncoding_CS_7Request">request(_:_:parameters:encoding:)</a>
119
+ </li>
120
+ <li class="nav-chapter">
121
+ <a href="../Functions.html#/s:F9Alamofire7requestFPS_21URLRequestConvertible_CS_7Request">request(_:)</a>
122
+ </li>
123
+ <li class="nav-chapter">
124
+ <a href="../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo5NSURL_CS_7Request">upload(_:_:_:)</a>
125
+ </li>
126
+ <li class="nav-chapter">
127
+ <a href="../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo5NSURL_CS_7Request">upload(_:_:)</a>
128
+ </li>
129
+ <li class="nav-chapter">
130
+ <a href="../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo6NSData_CS_7Request">upload(_:_:_:)</a>
131
+ </li>
132
+ <li class="nav-chapter">
133
+ <a href="../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo6NSData_CS_7Request">upload(_:_:)</a>
134
+ </li>
135
+ <li class="nav-chapter">
136
+ <a href="../Functions.html#/s:F9Alamofire6uploadFTOS_6MethodPS_20URLStringConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:_:)</a>
137
+ </li>
138
+ <li class="nav-chapter">
139
+ <a href="../Functions.html#/s:F9Alamofire6uploadFTPS_21URLRequestConvertible_CSo13NSInputStream_CS_7Request">upload(_:_:)</a>
140
+ </li>
141
+ <li class="nav-chapter">
142
+ <a href="../Functions.html#/s:F9Alamofire8downloadFTOS_6MethodPS_20URLStringConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S2__CS_7Request">download(_:_:_:)</a>
143
+ </li>
144
+ <li class="nav-chapter">
145
+ <a href="../Functions.html#/s:F9Alamofire8downloadFTPS_21URLRequestConvertible_FTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(_:_:)</a>
146
+ </li>
147
+ <li class="nav-chapter">
148
+ <a href="../Functions.html#/s:F9Alamofire8downloadFT10resumeDataCSo6NSDataFTCSo5NSURLCSo17NSHTTPURLResponse_S1__CS_7Request">download(resumeData:_:)</a>
149
+ </li>
150
+ </ul>
151
+ </li>
152
+ <li class="part-name tasks">
153
+ <a href="../Protocols.html">Protocols</a>
154
+ <ul class="nav-chapters">
155
+ <li class="nav-chapter">
156
+ <a href="../Protocols/URLStringConvertible.html">URLStringConvertible</a>
157
+ </li>
158
+ <li class="nav-chapter">
159
+ <a href="../Protocols/URLRequestConvertible.html">URLRequestConvertible</a>
160
+ </li>
161
+ </ul>
162
+ </li>
163
+ <li class="part-name tasks">
164
+ <a href="../Typealiases.html">Typealiases</a>
165
+ <ul class="nav-chapters">
166
+ <li class="nav-chapter">
167
+ <a href="../Typealiases.html#/s:C9Alamofire7Request10Validation">Validation</a>
168
+ </li>
169
+ <li class="nav-chapter">
170
+ <a href="../Typealiases.html#/s:C9Alamofire7Request23DownloadFileDestination">DownloadFileDestination</a>
171
+ </li>
172
+ </ul>
173
+ </li>
174
+ </ul>
175
+ </nav>
176
+ <div class="pixel-line"></div>
177
+ <div class="rubber-band-gap"></div>
178
+ <article class="chapter">
179
+ <a name="/"></a>
180
+ <h1 class="chapter-name">ParameterEncoding</h1>
181
+ <section>
182
+ <section class="section">
183
+ <p class="para">Used to specify the way in which a set of parameters are applied to a URL request.</p>
184
+ </section>
185
+ <section class="section task-group-section">
186
+ <div class="task-group">
187
+ <div class="task-name-container">
188
+ <a name="/Children"></a>
189
+ <a href="#/Children">
190
+ <h3 class="section-name"></h3>
191
+ </a>
192
+ </div>
193
+ <ul class="task-group-list">
194
+ <li class="item symbol">
195
+ <div class="task-group-term">
196
+ <code>
197
+ <a name="/s:FO9Alamofire17ParameterEncoding6encodeFS0_FTPS_21URLRequestConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject____TCSo12NSURLRequestGSqCSo7NSError__">
198
+ <a class="x-instance-method Swift" href="#/s:FO9Alamofire17ParameterEncoding6encodeFS0_FTPS_21URLRequestConvertible_10parametersGSqGVSs10DictionarySSPSs9AnyObject____TCSo12NSURLRequestGSqCSo7NSError__">encode(_:parameters:)</a>
199
+ </code>
200
+ </div>
201
+ <div class="height-container">
202
+ <div class="pointy-thing-container"></div>
203
+ <section class="section instance-method">
204
+ <div class="pointy-thing"></div>
205
+ <div class="abstract">
206
+ <p class="para">Creates a URL request by encoding parameters and applying them onto an existing request.</p>
207
+ </div>
208
+ <div class="declaration">
209
+ <h4>Declaration</h4>
210
+
211
+ <div class="Swift">
212
+ <p class="aside-title">Swift</p>
213
+ <p class="para">
214
+ <code>public func encode(URLRequest: URLRequestConvertible, parameters: [String : AnyObject]?) -&gt; (NSURLRequest, NSError?)</code>
215
+ </p>
216
+ </div>
217
+ </div>
218
+ <div class="parameters">
219
+ <h4>Parameters</h4>
220
+ <table class="graybox" border="0" cellspacing="0" cellpadding="5">
221
+ <tbody>
222
+ <tr>
223
+ <td scope="row">
224
+ <code>
225
+ <em class="term">URLRequest</em>
226
+ </code>
227
+ </td>
228
+ <td>
229
+ <div class="definition">
230
+ <p class="para">The request to have parameters applied</p>
231
+ </div>
232
+ </td>
233
+ </tr>
234
+ <tr>
235
+ <td scope="row">
236
+ <code>
237
+ <em class="term">parameters</em>
238
+ </code>
239
+ </td>
240
+ <td>
241
+ <div class="definition">
242
+ <p class="para">The parameters to apply</p>
243
+ </div>
244
+ </td>
245
+ </tr>
246
+ </tbody>
247
+ </table>
248
+ </div>
249
+ <div class="result-description">
250
+ <h4>Return Value</h4>
251
+ <p class="para">A tuple containing the constructed request and the error that occurred during parameter encoding, if any.</p>
252
+ </div>
253
+ <div class="result-description view-on-github">
254
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L77">Show on GitHub</a>
255
+ </div>
256
+ </section>
257
+ </div>
258
+ </li>
259
+ <li class="item symbol">
260
+ <div class="task-group-term">
261
+ <code>
262
+ <a name="/s:FO9Alamofire17ParameterEncoding12PropertyListFMS0_FTOSC20NSPropertyListFormatSi_S0_">
263
+ <a class="x-instance-method Swift" href="#/s:FO9Alamofire17ParameterEncoding12PropertyListFMS0_FTOSC20NSPropertyListFormatSi_S0_">PropertyList</a>
264
+ </code>
265
+ </div>
266
+ <div class="height-container">
267
+ <div class="pointy-thing-container"></div>
268
+ <section class="section instance-method">
269
+ <div class="pointy-thing"></div>
270
+ <div class="abstract">
271
+ <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>
272
+ </div>
273
+ <div class="result-description view-on-github">
274
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L62">Show on GitHub</a>
275
+ </div>
276
+ </section>
277
+ </div>
278
+ </li>
279
+ <li class="item symbol">
280
+ <div class="task-group-term">
281
+ <code>
282
+ <a name="/s:FO9Alamofire17ParameterEncoding4JSONFMS0_S0_">
283
+ <a class="x-instance-method Swift" href="#/s:FO9Alamofire17ParameterEncoding4JSONFMS0_S0_">JSON</a>
284
+ </code>
285
+ </div>
286
+ <div class="height-container">
287
+ <div class="pointy-thing-container"></div>
288
+ <section class="section instance-method">
289
+ <div class="pointy-thing"></div>
290
+ <div class="abstract">
291
+ <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>
292
+ </div>
293
+ <div class="result-description view-on-github">
294
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L57">Show on GitHub</a>
295
+ </div>
296
+ </section>
297
+ </div>
298
+ </li>
299
+ <li class="item symbol">
300
+ <div class="task-group-term">
301
+ <code>
302
+ <a name="/s:FO9Alamofire17ParameterEncoding3URLFMS0_S0_">
303
+ <a class="x-instance-method Swift" href="#/s:FO9Alamofire17ParameterEncoding3URLFMS0_S0_">URL</a>
304
+ </code>
305
+ </div>
306
+ <div class="height-container">
307
+ <div class="pointy-thing-container"></div>
308
+ <section class="section instance-method">
309
+ <div class="pointy-thing"></div>
310
+ <div class="abstract">
311
+ <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>
312
+ </div>
313
+ <div class="result-description view-on-github">
314
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L52">Show on GitHub</a>
315
+ </div>
316
+ </section>
317
+ </div>
318
+ </li>
319
+ <li class="item symbol">
320
+ <div class="task-group-term">
321
+ <code>
322
+ <a name="/s:FO9Alamofire17ParameterEncoding6CustomFMS0_FFTPS_21URLRequestConvertible_GSqGVSs10DictionarySSPSs9AnyObject____TCSo12NSURLRequestGSqCSo7NSError__S0_">
323
+ <a class="x-instance-method Swift" href="#/s:FO9Alamofire17ParameterEncoding6CustomFMS0_FFTPS_21URLRequestConvertible_GSqGVSs10DictionarySSPSs9AnyObject____TCSo12NSURLRequestGSqCSo7NSError__S0_">Custom</a>
324
+ </code>
325
+ </div>
326
+ <div class="height-container">
327
+ <div class="pointy-thing-container"></div>
328
+ <section class="section instance-method">
329
+ <div class="pointy-thing"></div>
330
+ <div class="abstract">
331
+ <p class="para">Uses the associated closure value to construct a new request given an existing request and parameters.</p>
332
+ </div>
333
+ <div class="result-description view-on-github">
334
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L67">Show on GitHub</a>
335
+ </div>
336
+ </section>
337
+ </div>
338
+ </li>
339
+ <li class="item symbol">
340
+ <div class="task-group-term">
341
+ <code>
342
+ <a name="/s:FO9Alamofire17ParameterEncoding15queryComponentsFS0_FTSSPSs9AnyObject__GSaTSSSS__">
343
+ <a class="x-instance-method Swift" href="#/s:FO9Alamofire17ParameterEncoding15queryComponentsFS0_FTSSPSs9AnyObject__GSaTSSSS__">queryComponents(_:_:)</a>
344
+ </code>
345
+ </div>
346
+ <div class="height-container">
347
+ <div class="pointy-thing-container"></div>
348
+ <section class="section instance-method">
349
+ <div class="pointy-thing"></div>
350
+ <div class="abstract">
351
+ <p class="para">Undocumented</p>
352
+ </div>
353
+ <div class="result-description view-on-github">
354
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L0">Show on GitHub</a>
355
+ </div>
356
+ </section>
357
+ </div>
358
+ </li>
359
+ <li class="item symbol">
360
+ <div class="task-group-term">
361
+ <code>
362
+ <a name="/s:FO9Alamofire17ParameterEncoding6escapeFS0_FSSSS">
363
+ <a class="x-instance-method Swift" href="#/s:FO9Alamofire17ParameterEncoding6escapeFS0_FSSSS">escape(_:)</a>
364
+ </code>
365
+ </div>
366
+ <div class="height-container">
367
+ <div class="pointy-thing-container"></div>
368
+ <section class="section instance-method">
369
+ <div class="pointy-thing"></div>
370
+ <div class="abstract">
371
+ <p class="para">Undocumented</p>
372
+ </div>
373
+ <div class="result-description view-on-github">
374
+ <a href="https://github.com/Alamofire/Alamofire/blob/1.1.0/Source/Alamofire.swift#L0">Show on GitHub</a>
375
+ </div>
376
+ </section>
377
+ </div>
378
+ </li>
379
+ </ul>
380
+ </div>
381
+ </section>
382
+ </section>
383
+ <section id="footer">
384
+ <p class="copyright">&copy; 2014 <a class="link" href="https://nshipster.com/alamofire" target="_blank" rel="external">Alamofire</a>. All rights reserved. (Last updated: 2014-01-01)</p>
385
+ <p class="copyright">Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.0.5</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
386
+ </section>
387
+ </article>
388
+ </div>
389
+ </body>
390
+ </div>
391
+ </html>