jazzy 0.0.4 → 0.0.6
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.gitignore +2 -2
- data/.gitmodules +3 -0
- data/.rubocop.yml +67 -0
- data/.rubocop_todo.yml +16 -0
- data/.travis.yml +6 -0
- data/Gemfile +15 -7
- data/Gemfile.lock +62 -12
- data/LICENSE +0 -0
- data/README.md +39 -12
- data/Rakefile +87 -1
- data/bin/jazzy +10 -44
- data/bin/sourcekitten +0 -0
- data/jazzy.gemspec +16 -16
- data/lib/jazzy.rb +1 -159
- data/lib/jazzy/assets/css/jazzy.css +561 -0
- data/lib/{assets/Images/carat_2x.png → jazzy/assets/img/carat.png} +0 -0
- data/lib/jazzy/assets/img/dash.png +0 -0
- data/lib/jazzy/assets/img/gh.png +0 -0
- data/lib/jazzy/assets/js/jazzy.js +15 -0
- data/lib/jazzy/assets/js/jquery.min.js +4 -0
- data/lib/jazzy/config.rb +100 -0
- data/lib/jazzy/doc.mustache +46 -0
- data/lib/jazzy/doc.rb +23 -0
- data/lib/jazzy/doc_builder.rb +166 -0
- data/lib/jazzy/gem_version.rb +3 -0
- data/lib/jazzy/jazzy_markdown.rb +13 -0
- data/lib/jazzy/partials/footer.mustache +4 -0
- data/lib/jazzy/partials/nav.mustache +16 -0
- data/lib/jazzy/partials/parameter.mustache +12 -0
- data/lib/jazzy/partials/task.mustache +66 -0
- data/lib/jazzy/partials/tasks.mustache +7 -0
- data/lib/jazzy/source_declaration.rb +19 -0
- data/lib/jazzy/sourcekitten.rb +146 -0
- data/lib/jazzy/xml_helper.rb +15 -0
- data/screenshot.jpg +0 -0
- data/spec/.gitkeep +0 -0
- data/spec/integration_spec.rb +89 -0
- data/spec/integration_specs/document_alamofire/after/docs/Classes.html +266 -0
- data/spec/integration_specs/document_alamofire/after/docs/Classes/Manager.html +677 -0
- data/spec/integration_specs/document_alamofire/after/docs/Classes/Manager/SessionDelegate.html +866 -0
- data/spec/integration_specs/document_alamofire/after/docs/Classes/Manager/Singleton.html +246 -0
- data/spec/integration_specs/document_alamofire/after/docs/Classes/Request.html +1376 -0
- data/spec/integration_specs/document_alamofire/after/docs/Classes/Request/DataTaskDelegate.html +486 -0
- data/spec/integration_specs/document_alamofire/after/docs/Classes/Request/TaskDelegate.html +506 -0
- data/spec/integration_specs/document_alamofire/after/docs/Enums.html +266 -0
- data/spec/integration_specs/document_alamofire/after/docs/Enums/ParameterEncoding.html +391 -0
- data/spec/integration_specs/document_alamofire/after/docs/Extensions.html +641 -0
- data/spec/integration_specs/document_alamofire/after/docs/Extensions/Manager.html +376 -0
- data/spec/integration_specs/document_alamofire/after/docs/Extensions/NSURL.html +226 -0
- data/spec/integration_specs/document_alamofire/after/docs/Extensions/NSURLComponents.html +226 -0
- data/spec/integration_specs/document_alamofire/after/docs/Extensions/NSURLRequest.html +226 -0
- data/spec/integration_specs/document_alamofire/after/docs/Extensions/Request.html +377 -0
- data/spec/integration_specs/document_alamofire/after/docs/Extensions/Request/DownloadTaskDelegate.html +406 -0
- data/spec/integration_specs/document_alamofire/after/docs/Extensions/Request/MIMEType.html +286 -0
- data/spec/integration_specs/document_alamofire/after/docs/Extensions/Request/UploadTaskDelegate.html +266 -0
- data/spec/integration_specs/document_alamofire/after/docs/Extensions/String.html +226 -0
- data/spec/integration_specs/document_alamofire/after/docs/Functions.html +1001 -0
- data/spec/integration_specs/document_alamofire/after/docs/Global Variables.html +236 -0
- data/spec/integration_specs/document_alamofire/after/docs/Protocols.html +266 -0
- data/spec/integration_specs/document_alamofire/after/docs/Protocols/URLRequestConvertible.html +236 -0
- data/spec/integration_specs/document_alamofire/after/docs/Protocols/URLStringConvertible.html +236 -0
- data/spec/integration_specs/document_alamofire/after/docs/Typealiases.html +266 -0
- data/spec/integration_specs/document_alamofire/after/docs/css/jazzy.css +561 -0
- data/spec/integration_specs/document_alamofire/after/docs/img/carat.png +0 -0
- data/spec/integration_specs/document_alamofire/after/docs/img/dash.png +0 -0
- data/spec/integration_specs/document_alamofire/after/docs/img/gh.png +0 -0
- data/spec/integration_specs/document_alamofire/after/docs/index.html +194 -0
- data/spec/integration_specs/document_alamofire/after/docs/js/jazzy.js +15 -0
- data/spec/integration_specs/document_alamofire/after/docs/js/jquery.min.js +4 -0
- data/spec/integration_specs/document_alamofire/after/execution_output.txt +2 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/Classes.html +317 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/Classes/ImplicitlyInternalTopLevelClass.html +138 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/Enums.html +155 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/Enums/DocumentedEnum.html +128 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/Global Variables.html +138 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/css/jazzy.css +561 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/img/carat.png +0 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/img/dash.png +0 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/img/gh.png +0 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/index.html +99 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/js/jazzy.js +15 -0
- data/spec/integration_specs/misc_jazzy_features/after/docs/js/jquery.min.js +4 -0
- data/spec/integration_specs/misc_jazzy_features/after/execution_output.txt +2 -0
- data/spec/integration_specs/misc_jazzy_features/before/MiscJazzyFeatures.xcodeproj/project.pbxproj +293 -0
- data/{parser/ASTDump.xcodeproj → spec/integration_specs/misc_jazzy_features/before/MiscJazzyFeatures.xcodeproj}/project.xcworkspace/contents.xcworkspacedata +1 -1
- data/spec/integration_specs/misc_jazzy_features/before/MiscJazzyFeatures/Classes.swift +60 -0
- data/spec/integration_specs/misc_jazzy_features/before/MiscJazzyFeatures/Info.plist +28 -0
- data/spec/integration_specs/misc_jazzy_features/before/MiscJazzyFeatures/MiscJazzyFeatures.h +10 -0
- data/spec/integration_specs/misc_jazzy_features/before/docs/Classes.html +317 -0
- data/spec/integration_specs/misc_jazzy_features/before/docs/Classes/ImplicitlyInternalTopLevelClass.html +138 -0
- data/spec/integration_specs/misc_jazzy_features/before/docs/Enums.html +155 -0
- data/spec/integration_specs/misc_jazzy_features/before/docs/Enums/DocumentedEnum.html +128 -0
- data/spec/integration_specs/misc_jazzy_features/before/docs/Global Variables.html +138 -0
- data/spec/integration_specs/misc_jazzy_features/before/docs/css/jazzy.css +561 -0
- data/spec/integration_specs/misc_jazzy_features/before/docs/img/carat.png +0 -0
- data/spec/integration_specs/misc_jazzy_features/before/docs/img/dash.png +0 -0
- data/spec/integration_specs/misc_jazzy_features/before/docs/img/gh.png +0 -0
- data/spec/integration_specs/misc_jazzy_features/before/docs/index.html +99 -0
- data/spec/integration_specs/misc_jazzy_features/before/docs/js/jazzy.js +15 -0
- data/spec/integration_specs/misc_jazzy_features/before/docs/js/jquery.min.js +4 -0
- metadata +112 -76
- data/DEV_README.md +0 -35
- data/bin/ASTDump +0 -0
- data/bin/generate_swift_header.sh +0 -14
- data/lib/assets/CSS/style-1.1.15.css +0 -3366
- data/lib/assets/Images/apple2.png +0 -0
- data/lib/assets/Images/check.png +0 -0
- data/lib/assets/Images/class_node_parent_and_child_2x.png +0 -0
- data/lib/assets/Images/class_node_subclass_last_child_2x.png +0 -0
- data/lib/assets/Images/class_node_subclass_with_siblings_2x.png +0 -0
- data/lib/assets/Images/closebox_2x.png +0 -0
- data/lib/assets/Images/collection_last_child_2x.png +0 -0
- data/lib/assets/Images/collection_last_child_orphan_grandparent_2x.png +0 -0
- data/lib/assets/Images/collection_last_child_orphan_parent_2x.png +0 -0
- data/lib/assets/Images/collection_last_child_orphan_parent_and_grandparent_2x.png +0 -0
- data/lib/assets/Images/collection_node_2x.png +0 -0
- data/lib/assets/Images/collection_node_orphan_grandparent_2x.png +0 -0
- data/lib/assets/Images/collection_node_orphan_parent_2x.png +0 -0
- data/lib/assets/Images/collection_node_orphan_parent_and_grandparent_2x.png +0 -0
- data/lib/assets/Images/collection_node_parent_2x.png +0 -0
- data/lib/assets/Images/collection_node_parent_last_child_orphan_parent_2x.png +0 -0
- data/lib/assets/Images/collection_node_parent_orphan_parent_2x.png +0 -0
- data/lib/assets/Images/collection_parent_last_child_2x.png +0 -0
- data/lib/assets/Images/download_2x.png +0 -0
- data/lib/assets/Images/left_arrow_2x.png +0 -0
- data/lib/assets/Images/magnify_2x.png +0 -0
- data/lib/assets/Images/minus_2x.png +0 -0
- data/lib/assets/Images/playbutton.svg +0 -15
- data/lib/assets/Images/plus_2x.png +0 -0
- data/lib/assets/Images/right_arrow_2x.png +0 -0
- data/lib/assets/Images/search_2x.png +0 -0
- data/lib/assets/Images/shortstack_2x.png +0 -0
- data/lib/assets/JavaScript/devpubs-1.1.15.js +0 -1293
- data/lib/jazzy/jazzhtml.rb +0 -7
- data/lib/jazzy/klass.mustache +0 -150
- data/lib/jazzy/klass.rb +0 -23
- data/lib/jazzy/partials/klass-method.mustache +0 -70
- data/lib/jazzy/partials/klass-overview.mustache +0 -6
- data/lib/jazzy/partials/klass-property.mustache +0 -41
- data/parser/ASTDump.xcodeproj/project.pbxproj +0 -301
- data/parser/ASTDump.xcodeproj/project.xcworkspace/xcshareddata/ASTDump.xccheckout +0 -41
- data/parser/ASTDump.xcodeproj/project.xcworkspace/xcuserdata/ta.xcuserdatad/UserInterfaceState.xcuserstate +0 -0
- data/parser/ASTDump.xcodeproj/xcuserdata/ta.xcuserdatad/xcschemes/ASTDump.xcscheme +0 -86
- data/parser/ASTDump.xcodeproj/xcuserdata/ta.xcuserdatad/xcschemes/xcschememanagement.plist +0 -22
- data/parser/ASTDump/main.cpp +0 -71
- data/parser/clang-c/BuildSystem.h +0 -148
- data/parser/clang-c/CXCompilationDatabase.h +0 -170
- data/parser/clang-c/CXErrorCode.h +0 -64
- data/parser/clang-c/CXString.h +0 -61
- data/parser/clang-c/Documentation.h +0 -554
- data/parser/clang-c/Index.h +0 -5454
- data/parser/clang-c/Platform.h +0 -45
- data/sample/JAZMusician.h +0 -38
- data/sample/JAZMusician.m +0 -19
- data/sample/Musician.swift +0 -37
data/spec/integration_specs/document_alamofire/after/docs/Protocols/URLRequestConvertible.html
ADDED
@@ -0,0 +1,236 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html lang="en">
|
3
|
+
<head>
|
4
|
+
<title>URLRequestConvertible Protocol 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="URLRequestConvertible Protocol 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
|
+
URLRequestConvertible Protocol 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">URLRequestConvertible</h1>
|
181
|
+
<section>
|
182
|
+
<section class="section">
|
183
|
+
<p class="para">Types adopting the <code>URLRequestConvertible</code> protocol can be used to construct URL requests.</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:vP9Alamofire21URLRequestConvertible10URLRequestCSo12NSURLRequest">
|
198
|
+
<a class="x-instance-method Swift" href="#/s:vP9Alamofire21URLRequestConvertible10URLRequestCSo12NSURLRequest">URLRequest</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">The URL 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>var URLRequest: NSURLRequest { get }</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#L201">Show on GitHub</a>
|
220
|
+
</div>
|
221
|
+
</section>
|
222
|
+
</div>
|
223
|
+
</li>
|
224
|
+
</ul>
|
225
|
+
</div>
|
226
|
+
</section>
|
227
|
+
</section>
|
228
|
+
<section id="footer">
|
229
|
+
<p class="copyright">© 2014 <a class="link" href="https://nshipster.com/alamofire" target="_blank" rel="external">Alamofire</a>. All rights reserved. (Last updated: 2014-01-01)</p>
|
230
|
+
<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>
|
231
|
+
</section>
|
232
|
+
</article>
|
233
|
+
</div>
|
234
|
+
</body>
|
235
|
+
</div>
|
236
|
+
</html>
|
@@ -0,0 +1,236 @@
|
|
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
|
+
<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="URLStringConvertible Protocol 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
|
+
URLStringConvertible Protocol 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">URLStringConvertible</h1>
|
181
|
+
<section>
|
182
|
+
<section class="section">
|
183
|
+
<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>
|
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:vP9Alamofire20URLStringConvertible9URLStringSS">
|
198
|
+
<a class="x-instance-method Swift" href="#/s:vP9Alamofire20URLStringConvertible9URLStringSS">URLString</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">The URL string.</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>var URLString: String { get }</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#L167">Show on GitHub</a>
|
220
|
+
</div>
|
221
|
+
</section>
|
222
|
+
</div>
|
223
|
+
</li>
|
224
|
+
</ul>
|
225
|
+
</div>
|
226
|
+
</section>
|
227
|
+
</section>
|
228
|
+
<section id="footer">
|
229
|
+
<p class="copyright">© 2014 <a class="link" href="https://nshipster.com/alamofire" target="_blank" rel="external">Alamofire</a>. All rights reserved. (Last updated: 2014-01-01)</p>
|
230
|
+
<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>
|
231
|
+
</section>
|
232
|
+
</article>
|
233
|
+
</div>
|
234
|
+
</body>
|
235
|
+
</div>
|
236
|
+
</html>
|