From f883aea95e472b24c30bcfc33f338f74f5122b63 Mon Sep 17 00:00:00 2001 From: John Fairhurst Date: Fri, 14 Jul 2017 12:12:11 +0100 Subject: [PATCH] update for jazzy-jf-autolink-fixes --- .../after/docs/Classes/SessionManager.html | 16 +- document_alamofire/after/docs/Functions.html | 12 +- .../after/docs/Structs/DataResponse.html | 2 +- .../after/docs/Structs/DownloadResponse.html | 2 +- .../Documents/Classes/SessionManager.html | 16 +- .../Resources/Documents/Functions.html | 12 +- .../Documents/Structs/DataResponse.html | 2 +- .../Documents/Structs/DownloadResponse.html | 2 +- .../Contents/Resources/Documents/index.html | 104 ++++---- document_alamofire/after/docs/index.html | 104 ++++---- .../after/docs/Classes/Endpoint.html | 31 --- .../after/docs/Classes/Response.html | 31 --- .../Resources/Documents/Classes/Endpoint.html | 31 --- .../Resources/Documents/Classes/Response.html | 31 --- .../after/docs/Classes/RLMArray.html | 12 +- .../after/docs/Classes/RLMMigration.html | 6 +- .../after/docs/Classes/RLMRealm.html | 6 +- .../after/docs/Classes/RLMResults.html | 4 +- .../docs/Classes/RLMSyncConfiguration.html | 2 +- .../docs/Classes/RLMSyncPermissionChange.html | 2 +- .../RLMSyncPermissionOfferResponse.html | 2 +- .../docs/Classes/RLMSyncPermissionValue.html | 2 +- .../after/docs/Protocols/RLMCollection.html | 4 +- .../after/docs/Type Definitions.html | 2 +- .../Resources/Documents/Classes/RLMArray.html | 12 +- .../Documents/Classes/RLMMigration.html | 6 +- .../Resources/Documents/Classes/RLMRealm.html | 6 +- .../Documents/Classes/RLMResults.html | 4 +- .../Classes/RLMSyncConfiguration.html | 2 +- .../Classes/RLMSyncPermissionChange.html | 2 +- .../RLMSyncPermissionOfferResponse.html | 2 +- .../Classes/RLMSyncPermissionValue.html | 2 +- .../Documents/Protocols/RLMCollection.html | 4 +- .../Resources/Documents/Type Definitions.html | 2 +- .../docs/Classes/AnyRealmCollection.html | 40 +-- .../after/docs/Classes/LinkingObjects.html | 40 +-- .../after/docs/Classes/List.html | 38 --- .../after/docs/Classes/Migration.html | 6 +- .../after/docs/Classes/Realm.html | 6 +- .../docs/Classes/Realm/Configuration.html | 2 +- .../after/docs/Classes/Results.html | 40 +-- .../docs/Classes/SyncPermissionChange.html | 2 +- .../Classes/SyncPermissionOfferResponse.html | 2 +- .../Extensions/SyncPermissionResults.html | 19 -- .../after/docs/Protocols/RealmCollection.html | 4 +- .../after/docs/Typealiases.html | 2 +- .../Documents/Classes/AnyRealmCollection.html | 40 +-- .../Documents/Classes/LinkingObjects.html | 40 +-- .../Resources/Documents/Classes/List.html | 38 --- .../Documents/Classes/Migration.html | 6 +- .../Resources/Documents/Classes/Realm.html | 6 +- .../Classes/Realm/Configuration.html | 2 +- .../Resources/Documents/Classes/Results.html | 40 +-- .../Classes/SyncPermissionChange.html | 2 +- .../Classes/SyncPermissionOfferResponse.html | 2 +- .../Extensions/SyncPermissionResults.html | 19 -- .../Documents/Protocols/RealmCollection.html | 4 +- .../Resources/Documents/Typealiases.html | 2 +- .../after/api-docs/Classes/Service.html | 12 +- .../Structs/ResponseContentTransformer.html | 2 +- .../Resources/Documents/Classes/Service.html | 12 +- .../Structs/ResponseContentTransformer.html | 2 +- .../docs/Classes/ClassWithInitializers.html | 13 + .../ImplicitlyInternalTopLevelClass.html | 11 + .../NestedClass.html | 11 + .../after/docs/Classes/MiscMarkdown.html | 11 + .../after/docs/Classes/Operators.html | 244 +++++++++++++++++ .../after/docs/Classes/TopLevelClass.html | 11 + .../Classes/TopLevelClass/NestedLevel1.html | 11 + .../NestedLevel1/NestedLevel2.html | 11 + .../after/docs/Enums/DocumentedEnum.html | 11 + .../after/docs/Enums/UndocumentedEnum.html | 11 + .../after/docs/Extensions/NSObject.html | 11 + .../after/docs/Extensions/String.html | 11 + .../docs/Extensions/String/CharacterView.html | 11 + .../docs/Functions/_2F_28_5F_3A_5F_3A_29.html | 11 + misc_jazzy_features/after/docs/Guides.html | 13 + .../after/docs/Other Classes.html | 35 +++ .../after/docs/Other Enums.html | 11 + .../after/docs/Other Extensions.html | 11 + .../after/docs/Other Functions.html | 13 + .../after/docs/Other Global Variables.html | 11 + .../after/docs/Other Structs.html | 251 ++++++++++++++++++ .../after/docs/Structs/GenericStruct.html | 250 +++++++++++++++++ misc_jazzy_features/after/docs/Yang.html | 11 + misc_jazzy_features/after/docs/Yin.html | 11 + .../Classes/ClassWithInitializers.html | 13 + .../ImplicitlyInternalTopLevelClass.html | 11 + .../NestedClass.html | 11 + .../Documents/Classes/MiscMarkdown.html | 11 + .../Documents/Classes/Operators.html | 244 +++++++++++++++++ .../Documents/Classes/TopLevelClass.html | 11 + .../Classes/TopLevelClass/NestedLevel1.html | 11 + .../NestedLevel1/NestedLevel2.html | 11 + .../Documents/Enums/DocumentedEnum.html | 11 + .../Documents/Enums/UndocumentedEnum.html | 11 + .../Documents/Extensions/NSObject.html | 11 + .../Documents/Extensions/String.html | 11 + .../Extensions/String/CharacterView.html | 11 + .../Functions/_2F_28_5F_3A_5F_3A_29.html | 11 + .../Contents/Resources/Documents/Guides.html | 13 + .../Resources/Documents/Other Classes.html | 35 +++ .../Resources/Documents/Other Enums.html | 11 + .../Resources/Documents/Other Extensions.html | 11 + .../Resources/Documents/Other Functions.html | 13 + .../Documents/Other Global Variables.html | 11 + .../Resources/Documents/Other Structs.html | 251 ++++++++++++++++++ .../Documents/Structs/GenericStruct.html | 250 +++++++++++++++++ .../Contents/Resources/Documents/Yang.html | 11 + .../Contents/Resources/Documents/Yin.html | 11 + .../Resources/Documents/example-1.html | 13 + .../Resources/Documents/example-2.html | 11 + .../Contents/Resources/Documents/index.html | 19 +- .../Contents/Resources/Documents/search.json | 2 +- .../Contents/Resources/docSet.dsidx.csv | 109 ++++---- misc_jazzy_features/after/docs/example-1.html | 13 + misc_jazzy_features/after/docs/example-2.html | 11 + misc_jazzy_features/after/docs/index.html | 19 +- misc_jazzy_features/after/docs/search.json | 2 +- .../after/docs/undocumented.json | 14 + .../after/execution_output.txt | 4 +- misc_jazzy_features/before/Extra/Example 1.md | 2 + .../before/MiscJazzyFeatures/Callouts.swift | 1 + .../before/MiscJazzyFeatures/Classes.swift | 7 + .../before/MiscJazzyFeatures/Filenames.swift | 7 + misc_jazzy_features/before/README.md | 8 +- .../before/Sections/ClassWithInitializers.md | 4 +- misc_jazzy_features/before/Sections/Guides.md | 4 +- 128 files changed, 2423 insertions(+), 749 deletions(-) create mode 100644 misc_jazzy_features/after/docs/Classes/Operators.html create mode 100644 misc_jazzy_features/after/docs/Other Structs.html create mode 100644 misc_jazzy_features/after/docs/Structs/GenericStruct.html create mode 100644 misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/Operators.html create mode 100644 misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Other Structs.html create mode 100644 misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Structs/GenericStruct.html diff --git a/document_alamofire/after/docs/Classes/SessionManager.html b/document_alamofire/after/docs/Classes/SessionManager.html index 1067df493..4b16b6583 100644 --- a/document_alamofire/after/docs/Classes/SessionManager.html +++ b/document_alamofire/after/docs/Classes/SessionManager.html @@ -886,7 +886,7 @@

Parameters

-

The parameter encoding. URLEncoding.default by default.

+

The parameter encoding. URLEncoding.default by default.

@@ -1066,7 +1066,7 @@

Parameters

-

The parameter encoding. URLEncoding.default by default.

+

The parameter encoding. URLEncoding.default by default.

@@ -1868,7 +1868,7 @@

Parameters

-

The closure used to append body parts to the MultipartFormData.

+

The closure used to append body parts to the MultipartFormData.

@@ -1881,7 +1881,7 @@

Parameters

The encoding memory threshold in bytes. - multipartFormDataEncodingMemoryThreshold by default.

+ multipartFormDataEncodingMemoryThreshold by default.

@@ -1929,7 +1929,7 @@

Parameters

-

The closure called when the MultipartFormData encoding is complete.

+

The closure called when the MultipartFormData encoding is complete.

@@ -1998,7 +1998,7 @@

Parameters

-

The closure used to append body parts to the MultipartFormData.

+

The closure used to append body parts to the MultipartFormData.

@@ -2011,7 +2011,7 @@

Parameters

The encoding memory threshold in bytes. - multipartFormDataEncodingMemoryThreshold by default.

+ multipartFormDataEncodingMemoryThreshold by default.

@@ -2035,7 +2035,7 @@

Parameters

-

The closure called when the MultipartFormData encoding is complete.

+

The closure called when the MultipartFormData encoding is complete.

diff --git a/document_alamofire/after/docs/Functions.html b/document_alamofire/after/docs/Functions.html index dbe824ea2..ca9232b67 100644 --- a/document_alamofire/after/docs/Functions.html +++ b/document_alamofire/after/docs/Functions.html @@ -365,7 +365,7 @@

Parameters

-

The parameter encoding. URLEncoding.default by default.

+

The parameter encoding. URLEncoding.default by default.

@@ -542,7 +542,7 @@

Parameters

-

The parameter encoding. URLEncoding.default by default.

+

The parameter encoding. URLEncoding.default by default.

@@ -1332,7 +1332,7 @@

Parameters

-

The closure used to append body parts to the MultipartFormData.

+

The closure used to append body parts to the MultipartFormData.

@@ -1393,7 +1393,7 @@

Parameters

-

The closure called when the MultipartFormData encoding is complete.

+

The closure called when the MultipartFormData encoding is complete.

@@ -1460,7 +1460,7 @@

Parameters

-

The closure used to append body parts to the MultipartFormData.

+

The closure used to append body parts to the MultipartFormData.

@@ -1497,7 +1497,7 @@

Parameters

-

The closure called when the MultipartFormData encoding is complete.

+

The closure called when the MultipartFormData encoding is complete.

diff --git a/document_alamofire/after/docs/Structs/DataResponse.html b/document_alamofire/after/docs/Structs/DataResponse.html index bfaab6410..5b8754870 100644 --- a/document_alamofire/after/docs/Structs/DataResponse.html +++ b/document_alamofire/after/docs/Structs/DataResponse.html @@ -585,7 +585,7 @@

Parameters

-

The timeline of the complete lifecycle of the Request. Defaults to Timeline().

+

The timeline of the complete lifecycle of the Request. Defaults to Timeline().

diff --git a/document_alamofire/after/docs/Structs/DownloadResponse.html b/document_alamofire/after/docs/Structs/DownloadResponse.html index 8dcd715da..92109d01c 100644 --- a/document_alamofire/after/docs/Structs/DownloadResponse.html +++ b/document_alamofire/after/docs/Structs/DownloadResponse.html @@ -671,7 +671,7 @@

Parameters

-

The timeline of the complete lifecycle of the Request. Defaults to Timeline().

+

The timeline of the complete lifecycle of the Request. Defaults to Timeline().

diff --git a/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Classes/SessionManager.html b/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Classes/SessionManager.html index 1067df493..4b16b6583 100644 --- a/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Classes/SessionManager.html +++ b/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Classes/SessionManager.html @@ -886,7 +886,7 @@

Parameters

-

The parameter encoding. URLEncoding.default by default.

+

The parameter encoding. URLEncoding.default by default.

@@ -1066,7 +1066,7 @@

Parameters

-

The parameter encoding. URLEncoding.default by default.

+

The parameter encoding. URLEncoding.default by default.

@@ -1868,7 +1868,7 @@

Parameters

-

The closure used to append body parts to the MultipartFormData.

+

The closure used to append body parts to the MultipartFormData.

@@ -1881,7 +1881,7 @@

Parameters

The encoding memory threshold in bytes. - multipartFormDataEncodingMemoryThreshold by default.

+ multipartFormDataEncodingMemoryThreshold by default.

@@ -1929,7 +1929,7 @@

Parameters

-

The closure called when the MultipartFormData encoding is complete.

+

The closure called when the MultipartFormData encoding is complete.

@@ -1998,7 +1998,7 @@

Parameters

-

The closure used to append body parts to the MultipartFormData.

+

The closure used to append body parts to the MultipartFormData.

@@ -2011,7 +2011,7 @@

Parameters

The encoding memory threshold in bytes. - multipartFormDataEncodingMemoryThreshold by default.

+ multipartFormDataEncodingMemoryThreshold by default.

@@ -2035,7 +2035,7 @@

Parameters

-

The closure called when the MultipartFormData encoding is complete.

+

The closure called when the MultipartFormData encoding is complete.

diff --git a/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Functions.html b/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Functions.html index dbe824ea2..ca9232b67 100644 --- a/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Functions.html +++ b/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Functions.html @@ -365,7 +365,7 @@

Parameters

-

The parameter encoding. URLEncoding.default by default.

+

The parameter encoding. URLEncoding.default by default.

@@ -542,7 +542,7 @@

Parameters

-

The parameter encoding. URLEncoding.default by default.

+

The parameter encoding. URLEncoding.default by default.

@@ -1332,7 +1332,7 @@

Parameters

-

The closure used to append body parts to the MultipartFormData.

+

The closure used to append body parts to the MultipartFormData.

@@ -1393,7 +1393,7 @@

Parameters

-

The closure called when the MultipartFormData encoding is complete.

+

The closure called when the MultipartFormData encoding is complete.

@@ -1460,7 +1460,7 @@

Parameters

-

The closure used to append body parts to the MultipartFormData.

+

The closure used to append body parts to the MultipartFormData.

@@ -1497,7 +1497,7 @@

Parameters

-

The closure called when the MultipartFormData encoding is complete.

+

The closure called when the MultipartFormData encoding is complete.

diff --git a/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Structs/DataResponse.html b/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Structs/DataResponse.html index bfaab6410..5b8754870 100644 --- a/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Structs/DataResponse.html +++ b/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Structs/DataResponse.html @@ -585,7 +585,7 @@

Parameters

-

The timeline of the complete lifecycle of the Request. Defaults to Timeline().

+

The timeline of the complete lifecycle of the Request. Defaults to Timeline().

diff --git a/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Structs/DownloadResponse.html b/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Structs/DownloadResponse.html index 8dcd715da..92109d01c 100644 --- a/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Structs/DownloadResponse.html +++ b/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/Structs/DownloadResponse.html @@ -671,7 +671,7 @@

Parameters

-

The timeline of the complete lifecycle of the Request. Defaults to Timeline().

+

The timeline of the complete lifecycle of the Request. Defaults to Timeline().

diff --git a/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/index.html b/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/index.html index fb0e880f3..8dcaf5669 100644 --- a/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/index.html +++ b/document_alamofire/after/docs/docsets/Alamofire.docset/Contents/Resources/Documents/index.html @@ -461,7 +461,7 @@

Making a Request

Response Handling

-

Handling the Response of a Request made in Alamofire involves chaining a response handler onto the Request.

+

Handling the Response of a Request made in Alamofire involves chaining a response handler onto the Request.

Alamofire.request("https://httpbin.org/get").responseJSON { response in
     print(response.request)  // original URL request
     print(response.response) // HTTP URL response
@@ -474,7 +474,7 @@ 

Response Handling

}
-

In the above example, the responseJSON handler is appended to the Request to be executed once the Request is complete. Rather than blocking execution to wait for a response from the server, a callback in the form of a closure is specified to handle the response once it’s received. The result of a request is only available inside the scope of a response closure. Any execution contingent on the response or data received from the server must be done within a response closure.

+

In the above example, the responseJSON handler is appended to the Request to be executed once the Request is complete. Rather than blocking execution to wait for a response from the server, a callback in the form of a closure is specified to handle the response once it’s received. The result of a request is only available inside the scope of a response closure. Any execution contingent on the response or data received from the server must be done within a response closure.

Networking in Alamofire is done asynchronously. Asynchronous programming may be a source of frustration to programmers unfamiliar with the concept, but there are very good reasons for doing it this way.

@@ -520,7 +520,7 @@

Response Handling

Response Handler

-

The response handler does NOT evaluate any of the response data. It merely forwards on all information directly from the URL session delegate. It is the Alamofire equivalent of using cURL to execute a Request.

+

The response handler does NOT evaluate any of the response data. It merely forwards on all information directly from the URL session delegate. It is the Alamofire equivalent of using cURL to execute a Request.

Alamofire.request("https://httpbin.org/get").response { response in
     print("Request: \(response.request)")
     print("Response: \(response.response)")
@@ -533,11 +533,11 @@ 

Response Handler

-

We strongly encourage you to leverage the other response serializers taking advantage of Response and Result types.

+

We strongly encourage you to leverage the other response serializers taking advantage of Response and Result types.

Response Data Handler

-

The responseData handler uses the responseDataSerializer (the object that serializes the server data into some other type) to extract the Data returned by the server. If no errors occur and Data is returned, the response Result will be a .success and the value will be of type Data.

+

The responseData handler uses the responseDataSerializer (the object that serializes the server data into some other type) to extract the Data returned by the server. If no errors occur and Data is returned, the response Result will be a .success and the value will be of type Data.

Alamofire.request("https://httpbin.org/get").responseData { response in
     debugPrint("All Response Info: \(response)")
 
@@ -548,7 +548,7 @@ 

Response Data Handler

Response String Handler

-

The responseString handler uses the responseStringSerializer to convert the Data returned by the server into a String with the specified encoding. If no errors occur and the server data is successfully serialized into a String, the response Result will be a .success and the value will be of type String.

+

The responseString handler uses the responseStringSerializer to convert the Data returned by the server into a String with the specified encoding. If no errors occur and the server data is successfully serialized into a String, the response Result will be a .success and the value will be of type String.

Alamofire.request("https://httpbin.org/get").responseString { response in
     print("Success: \(response.result.isSuccess)")
     print("Response String: \(response.result.value)")
@@ -560,7 +560,7 @@ 

Response String Handler

Response JSON Handler

-

The responseJSON handler uses the responseJSONSerializer to convert the Data returned by the server into an Any type using the specified JSONSerialization.ReadingOptions. If no errors occur and the server data is successfully serialized into a JSON object, the response Result will be a .success and the value will be of type Any.

+

The responseJSON handler uses the responseJSONSerializer to convert the Data returned by the server into an Any type using the specified JSONSerialization.ReadingOptions. If no errors occur and the server data is successfully serialized into a JSON object, the response Result will be a .success and the value will be of type Any.

Alamofire.request("https://httpbin.org/get").responseJSON { response in
     debugPrint(response)
 
@@ -586,7 +586,7 @@ 

Chained Response Handlers

-

It is important to note that using multiple response handlers on the same Request requires the server data to be serialized multiple times. Once for each response handler.

+

It is important to note that using multiple response handlers on the same Request requires the server data to be serialized multiple times. Once for each response handler.

Response Handler Queue

@@ -634,7 +634,7 @@

Response Caching

HTTP Methods

-

The HTTPMethod enumeration lists the HTTP methods defined in RFC 7231 §4.3:

+

The HTTPMethod enumeration lists the HTTP methods defined in RFC 7231 §4.3:

public enum HTTPMethod: String {
     case options = "OPTIONS"
     case get     = "GET"
@@ -661,10 +661,10 @@ 

HTTP Methods

Parameter Encoding

-

Alamofire supports three types of parameter encoding including: URL, JSON and PropertyList. It can also support any custom encoding that conforms to the ParameterEncoding protocol.

+

Alamofire supports three types of parameter encoding including: URL, JSON and PropertyList. It can also support any custom encoding that conforms to the ParameterEncoding protocol.

URL Encoding

-

The URLEncoding type creates a url-encoded query string to be set as or appended to any existing URL query string or set as the HTTP body of the URL request. Whether the query string is set or appended to any existing URL query string or set as the HTTP body depends on the Destination of the encoding. The Destination enumeration has three cases:

+

The URLEncoding type creates a url-encoded query string to be set as or appended to any existing URL query string or set as the HTTP body of the URL request. Whether the query string is set or appended to any existing URL query string or set as the HTTP body depends on the Destination of the encoding. The Destination enumeration has three cases:

  • .methodDependent - Applies encoded query string result to existing query string for GET, HEAD and DELETE requests and sets as the HTTP body for requests with any other HTTP method.
  • @@ -703,7 +703,7 @@
    POST Request W

JSON Encoding

-

The JSONEncoding type creates a JSON representation of the parameters object, which is set as the HTTP body of the request. The Content-Type HTTP header field of an encoded request is set to application/json.

+

The JSONEncoding type creates a JSON representation of the parameters object, which is set as the HTTP body of the request. The Content-Type HTTP header field of an encoded request is set to application/json.

POST Request with JSON-Encoded Parameters
let parameters: Parameters = [
     "foo": [1,2,3],
@@ -720,10 +720,10 @@ 
POST Request

Property List Encoding

-

The PropertyListEncoding uses PropertyListSerialization 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 Content-Type HTTP header field of an encoded request is set to application/x-plist.

+

The PropertyListEncoding uses PropertyListSerialization 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 Content-Type HTTP header field of an encoded request is set to application/x-plist.

Custom Encoding

-

In the event that the provided ParameterEncoding types do not meet your needs, you can create your own custom encoding. Here’s a quick example of how you could build a custom JSONStringArrayEncoding type to encode a JSON string array onto a Request.

+

In the event that the provided ParameterEncoding types do not meet your needs, you can create your own custom encoding. Here’s a quick example of how you could build a custom JSONStringArrayEncoding type to encode a JSON string array onto a Request.

struct JSONStringArrayEncoding: ParameterEncoding {
     private let array: [String]
 
@@ -748,7 +748,7 @@ 

Custom Encoding

Manual Parameter Encoding of a URLRequest

-

The ParameterEncoding APIs can be used outside of making network requests.

+

The ParameterEncoding APIs can be used outside of making network requests.

let url = URL(string: "https://httpbin.org/get")!
 var urlRequest = URLRequest(url: url)
 
@@ -757,7 +757,7 @@ 

Manual Parame

HTTP Headers

-

Adding a custom HTTP header to a Request is supported directly in the global request method. This makes it easy to attach HTTP headers to a Request that can be constantly changing.

+

Adding a custom HTTP header to a Request is supported directly in the global request method. This makes it easy to attach HTTP headers to a Request that can be constantly changing.

let headers: HTTPHeaders = [
     "Authorization": "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==",
     "Accept": "application/json"
@@ -772,7 +772,7 @@ 

HTTP Headers

For HTTP headers that do not change, it is recommended to set them on the URLSessionConfiguration so they are automatically applied to any URLSessionTask created by the underlying URLSession. For more information, see the Session Manager Configurations section.

-

The default Alamofire SessionManager provides a default set of headers for every Request. These include:

+

The default Alamofire SessionManager provides a default set of headers for every Request. These include:

  • Accept-Encoding, which defaults to gzip;q=1.0, compress;q=0.5, per RFC 7230 §4.2.3.
  • @@ -780,7 +780,7 @@

    HTTP Headers

  • User-Agent, which contains versioning information about the current app. For example: iOS Example/1.0 (com.alamofire.iOS-Example; build:1; iOS 10.0.0) Alamofire/4.0.0, per RFC 7231 §5.5.3.
-

If you need to customize these headers, a custom URLSessionConfiguration should be created, the defaultHTTPHeaders property updated and the configuration applied to a new SessionManager instance.

+

If you need to customize these headers, a custom URLSessionConfiguration should be created, the defaultHTTPHeaders property updated and the configuration applied to a new SessionManager instance.

Authentication

Authentication is handled on the system framework level by URLCredential and URLAuthenticationChallenge.

@@ -795,7 +795,7 @@

Authentication

HTTP Basic Authentication

-

The authenticate method on a Request will automatically provide a URLCredential to a URLAuthenticationChallenge when appropriate:

+

The authenticate method on a Request will automatically provide a URLCredential to a URLAuthenticationChallenge when appropriate:

let user = "user"
 let password = "password"
 
@@ -884,7 +884,7 @@ 

Download File Destination

Download Progress

-

Many times it can be helpful to report download progress to the user. Any DownloadRequest can report download progress using the downloadProgress API.

+

Many times it can be helpful to report download progress to the user. Any DownloadRequest can report download progress using the downloadProgress API.

Alamofire.download("https://httpbin.org/image/png")
     .downloadProgress { progress in
         print("Download Progress: \(progress.fractionCompleted)")
@@ -911,7 +911,7 @@ 

Download Progress

Resuming a Download

-

If a DownloadRequest is cancelled or interrupted, the underlying URL session may generate resume data for the active DownloadRequest. If this happens, the resume data can be re-used to restart the DownloadRequest where it left off. The resume data can be accessed through the download response, then reused when trying to restart the request.

+

If a DownloadRequest is cancelled or interrupted, the underlying URL session may generate resume data for the active DownloadRequest. If this happens, the resume data can be re-used to restart the DownloadRequest where it left off. The resume data can be accessed through the download response, then reused when trying to restart the request.

IMPORTANT: On the latest release of all the Apple platforms (iOS 10, macOS 10.12, tvOS 10, watchOS 3), resumeData is broken on background URL session configurations. There’s an underlying bug in the resumeData generation logic where the data is written incorrectly and will always fail to resume the download. For more information about the bug and possible workarounds, please see this Stack Overflow post.

@@ -991,7 +991,7 @@

Uploading Multipart Form

Upload Progress

-

While your user is waiting for their upload to complete, sometimes it can be handy to show the progress of the upload to the user. Any UploadRequest can report both upload progress and download progress of the response data using the uploadProgress and downloadProgress APIs.

+

While your user is waiting for their upload to complete, sometimes it can be handy to show the progress of the upload to the user. Any UploadRequest can report both upload progress and download progress of the response data using the uploadProgress and downloadProgress APIs.

let fileURL = Bundle.main.url(forResource: "video", withExtension: "mov")
 
 Alamofire.upload(fileURL, to: "https://httpbin.org/post")
@@ -1008,13 +1008,13 @@ 

Upload Progress

Statistical Metrics

Timeline

-

Alamofire collects timings throughout the lifecycle of a Request and creates a Timeline object exposed as a property on all response types.

+

Alamofire collects timings throughout the lifecycle of a Request and creates a Timeline object exposed as a property on all response types.

Alamofire.request("https://httpbin.org/get").responseJSON { response in
     print(response.timeline)
 }
 
-

The above reports the following Timeline info:

+

The above reports the following Timeline info:

  • Latency: 0.428 seconds
  • @@ -1024,7 +1024,7 @@

    Timeline

URL Session Task Metrics

-

In iOS and tvOS 10 and macOS 10.12, Apple introduced the new URLSessionTaskMetrics APIs. The task metrics encapsulate some fantastic statistical information about the request and response execution. The API is very similar to the Timeline, but provides many more statistics that Alamofire doesn’t have access to compute. The metrics can be accessed through any response type.

+

In iOS and tvOS 10 and macOS 10.12, Apple introduced the new URLSessionTaskMetrics APIs. The task metrics encapsulate some fantastic statistical information about the request and response execution. The API is very similar to the Timeline, but provides many more statistics that Alamofire doesn’t have access to compute. The metrics can be accessed through any response type.

Alamofire.request("https://httpbin.org/get").responseJSON { response in
     print(response.metrics)
 }
@@ -1039,7 +1039,7 @@ 

URL Session Task Metrics

cURL Command Output

-

Debugging platform issues can be frustrating. Thankfully, Alamofire Request objects conform to both the CustomStringConvertible and CustomDebugStringConvertible protocols to provide some VERY helpful debugging tools.

+

Debugging platform issues can be frustrating. Thankfully, Alamofire Request objects conform to both the CustomStringConvertible and CustomDebugStringConvertible protocols to provide some VERY helpful debugging tools.

CustomStringConvertible

let request = Alamofire.request("https://httpbin.org/ip")
 
@@ -1107,14 +1107,14 @@ 

Modifying the Sessi

-

This is not recommended for Authorization or Content-Type headers. Instead, use the headers parameter in the top-level Alamofire.request APIs, URLRequestConvertible and ParameterEncoding, respectively.

+

This is not recommended for Authorization or Content-Type headers. Instead, use the headers parameter in the top-level Alamofire.request APIs, URLRequestConvertible and ParameterEncoding, respectively.

Session Delegate

-

By default, an Alamofire SessionManager instance creates a SessionDelegate object to handle all the various types of delegate callbacks that are generated by the underlying URLSession. The implementations of each delegate method handle the most common use cases for these types of calls abstracting the complexity away from the top-level APIs. However, advanced users may find the need to override the default functionality for various reasons.

+

By default, an Alamofire SessionManager instance creates a SessionDelegate object to handle all the various types of delegate callbacks that are generated by the underlying URLSession. The implementations of each delegate method handle the most common use cases for these types of calls abstracting the complexity away from the top-level APIs. However, advanced users may find the need to override the default functionality for various reasons.

Override Closures

-

The first way to customize the SessionDelegate behavior is through the use of the override closures. Each closure gives you the ability to override the implementation of the matching SessionDelegate API, yet still use the default implementation for all other APIs. This makes it easy to customize subsets of the delegate functionality. Here are a few examples of some of the override closures available:

+

The first way to customize the SessionDelegate behavior is through the use of the override closures. Each closure gives you the ability to override the implementation of the matching SessionDelegate API, yet still use the default implementation for all other APIs. This makes it easy to customize subsets of the delegate functionality. Here are a few examples of some of the override closures available:

/// Overrides default behavior for URLSessionDelegate method `urlSession(_:didReceive:completionHandler:)`.
 open var sessionDidReceiveChallenge: ((URLSession, URLAuthenticationChallenge) -> (URLSession.AuthChallengeDisposition, URLCredential?))?
 
@@ -1148,7 +1148,7 @@ 

Override Closures

Subclassing

-

Another way to override the default implementation of the SessionDelegate is to subclass it. Subclassing allows you completely customize the behavior of the API or to create a proxy for the API and still use the default implementation. Creating a proxy allows you to log events, emit notifications, provide pre and post hook implementations, etc. Here’s a quick example of subclassing the SessionDelegate and logging a message when a redirect occurs.

+

Another way to override the default implementation of the SessionDelegate is to subclass it. Subclassing allows you completely customize the behavior of the API or to create a proxy for the API and still use the default implementation. Creating a proxy allows you to log events, emit notifications, provide pre and post hook implementations, etc. Here’s a quick example of subclassing the SessionDelegate and logging a message when a redirect occurs.

class LoggingSessionDelegate: SessionDelegate {
     override func urlSession(
         _ session: URLSession,
@@ -1177,7 +1177,7 @@ 

Subclassing

Request

-

The result of a request, download, upload or stream methods are a DataRequest, DownloadRequest, UploadRequest and StreamRequest which all inherit from Request. All Request instances are always created by an owning session manager, and never initialized directly.

+

The result of a request, download, upload or stream methods are a DataRequest, DownloadRequest, UploadRequest and StreamRequest which all inherit from Request. All Request instances are always created by an owning session manager, and never initialized directly.

Each subclass has specialized methods such as authenticate, validate, responseJSON and uploadProgress that each return the caller instance in order to facilitate method chaining.

@@ -1190,10 +1190,10 @@

Request

Routing Requests

-

As apps grow in size, it’s important to adopt common patterns as you build out your network stack. An important part of that design is how to route your requests. The Alamofire URLConvertible and URLRequestConvertible protocols along with the Router design pattern are here to help.

+

As apps grow in size, it’s important to adopt common patterns as you build out your network stack. An important part of that design is how to route your requests. The Alamofire URLConvertible and URLRequestConvertible protocols along with the Router design pattern are here to help.

URLConvertible

-

Types adopting the URLConvertible protocol can be used to construct URLs, which are then used to construct URL requests internally. String, URL, and URLComponents conform to URLConvertible by default, allowing any of them to be passed as url parameters to the request, upload, and download methods:

+

Types adopting the URLConvertible protocol can be used to construct URLs, which are then used to construct URL requests internally. String, URL, and URLComponents conform to URLConvertible by default, allowing any of them to be passed as url parameters to the request, upload, and download methods:

let urlString = "https://httpbin.org/post"
 Alamofire.request(urlString, method: .post)
 
@@ -1204,7 +1204,7 @@ 

URLConvertible

Alamofire.request(urlComponents, method: .post)
-

Applications interacting with web applications in a significant manner are encouraged to have custom types conform to URLConvertible as a convenient way to map domain-specific models to server resources.

+

Applications interacting with web applications in a significant manner are encouraged to have custom types conform to URLConvertible as a convenient way to map domain-specific models to server resources.

Type-Safe Routing
extension User: URLConvertible {
     static let baseURLString = "https://example.com"
@@ -1220,7 +1220,7 @@ 
Type-Safe Routing

URLRequestConvertible

-

Types adopting the URLRequestConvertible protocol can be used to construct URL requests. URLRequest conforms to URLRequestConvertible by default, allowing it to be passed into request, upload, and download methods directly (this is the recommended way to specify custom HTTP body for individual requests):

+

Types adopting the URLRequestConvertible protocol can be used to construct URL requests. URLRequest conforms to URLRequestConvertible by default, allowing it to be passed into request, upload, and download methods directly (this is the recommended way to specify custom HTTP body for individual requests):

let url = URL(string: "https://httpbin.org/post")!
 var urlRequest = URLRequest(url: url)
 urlRequest.httpMethod = "POST"
@@ -1238,7 +1238,7 @@ 

URLRequestConvertible

Alamofire.request(urlRequest)
-

Applications interacting with web applications in a significant manner are encouraged to have custom types conform to URLRequestConvertible as a way to ensure consistency of requested endpoints. Such an approach can be used to abstract away server-side inconsistencies and provide type-safe routing, as well as manage authentication credentials and other state.

+

Applications interacting with web applications in a significant manner are encouraged to have custom types conform to URLRequestConvertible as a way to ensure consistency of requested endpoints. Such an approach can be used to abstract away server-side inconsistencies and provide type-safe routing, as well as manage authentication credentials and other state.

API Parameter Abstraction
enum Router: URLRequestConvertible {
     case search(query: String, page: Int)
@@ -1331,10 +1331,10 @@ 

Adapting and Retrying Re

Most web services these days are behind some sort of authentication system. One of the more common ones today is OAuth. This generally involves generating an access token authorizing your application or user to call the various supported web services. While creating these initial access tokens can be laborsome, it can be even more complicated when your access token expires and you need to fetch a new one. There are many thread-safety issues that need to be considered.

-

The RequestAdapter and RequestRetrier protocols were created to make it much easier to create a thread-safe authentication system for a specific set of web services.

+

The RequestAdapter and RequestRetrier protocols were created to make it much easier to create a thread-safe authentication system for a specific set of web services.

RequestAdapter

-

The RequestAdapter protocol allows each Request made on a SessionManager to be inspected and adapted before being created. One very specific way to use an adapter is to append an Authorization header to requests behind a certain type of authentication.

+

The RequestAdapter protocol allows each Request made on a SessionManager to be inspected and adapted before being created. One very specific way to use an adapter is to append an Authorization header to requests behind a certain type of authentication.

class AccessTokenAdapter: RequestAdapter {
     private let accessToken: String
 
@@ -1360,10 +1360,10 @@ 

RequestAdapter

RequestRetrier

-

The RequestRetrier protocol allows a Request that encountered an Error while being executed to be retried. When using both the RequestAdapter and RequestRetrier protocols together, you can create credential refresh systems for OAuth1, OAuth2, Basic Auth and even exponential backoff retry policies. The possibilities are endless. Here’s an example of how you could implement a refresh flow for OAuth2 access tokens.

+

The RequestRetrier protocol allows a Request that encountered an Error while being executed to be retried. When using both the RequestAdapter and RequestRetrier protocols together, you can create credential refresh systems for OAuth1, OAuth2, Basic Auth and even exponential backoff retry policies. The possibilities are endless. Here’s an example of how you could implement a refresh flow for OAuth2 access tokens.

-

DISCLAIMER: This is NOT a global OAuth2 solution. It is merely an example demonstrating how one could use the RequestAdapter in conjunction with the RequestRetrier to create a thread-safe refresh system.

+

DISCLAIMER: This is NOT a global OAuth2 solution. It is merely an example demonstrating how one could use the RequestAdapter in conjunction with the RequestRetrier to create a thread-safe refresh system.

To reiterate, do NOT copy this sample code and drop it into a production application. This is merely an example. Each authentication system must be tailored to a particular platform and authentication type.

@@ -1491,7 +1491,7 @@

RequestRetrier

}
-

Once the OAuth2Handler is applied as both the adapter and retrier for the SessionManager, it will handle an invalid access token error by automatically refreshing the access token and retrying all failed requests in the same order they failed.

+

Once the OAuth2Handler is applied as both the adapter and retrier for the SessionManager, it will handle an invalid access token error by automatically refreshing the access token and retrying all failed requests in the same order they failed.

If you needed them to execute in the same order they were created, you could sort them by their task identifiers.

@@ -1521,7 +1521,7 @@

Custom Response Serializa

Response Mapping

-

Response mapping is the simplest way to produce customized responses. It transforms the value of a response, while preserving eventual errors and meta-data. For example, you can turn a json response DataResponse<Any> into a response that holds an application model, such as DataResponse<User>. You perform response mapping with the DataResponse.map method:

+

Response mapping is the simplest way to produce customized responses. It transforms the value of a response, while preserving eventual errors and meta-data. For example, you can turn a json response DataResponse<Any> into a response that holds an application model, such as DataResponse<User>. You perform response mapping with the DataResponse.map method:

Alamofire.request("https://example.com/users/mattt").responseJSON { (response: DataResponse<Any>) in
     let userResponse = response.map { json in
         // We assume an existing User(json: Any) initializer
@@ -1777,10 +1777,10 @@ 

Generic Response

Security

-

Using a secure HTTPS connection when communicating with servers and web services is an important step in securing sensitive data. By default, Alamofire will evaluate the certificate chain provided by the server using Apple’s built in validation provided by the Security framework. While this guarantees the certificate chain is valid, it does not prevent man-in-the-middle (MITM) attacks or other potential vulnerabilities. In order to mitigate MITM attacks, applications dealing with sensitive customer data or financial information should use certificate or public key pinning provided by the ServerTrustPolicy.

+

Using a secure HTTPS connection when communicating with servers and web services is an important step in securing sensitive data. By default, Alamofire will evaluate the certificate chain provided by the server using Apple’s built in validation provided by the Security framework. While this guarantees the certificate chain is valid, it does not prevent man-in-the-middle (MITM) attacks or other potential vulnerabilities. In order to mitigate MITM attacks, applications dealing with sensitive customer data or financial information should use certificate or public key pinning provided by the ServerTrustPolicy.

ServerTrustPolicy

-

The ServerTrustPolicy enumeration evaluates the server trust generally provided by an URLAuthenticationChallenge when connecting to a server over a secure HTTPS connection.

+

The ServerTrustPolicy enumeration evaluates the server trust generally provided by an URLAuthenticationChallenge when connecting to a server over a secure HTTPS connection.

let serverTrustPolicy = ServerTrustPolicy.pinCertificates(
     certificates: ServerTrustPolicy.certificates(),
     validateCertificateChain: true,
@@ -1799,7 +1799,7 @@ 

ServerTrustPolicy

Server Trust Policy Manager

-

The ServerTrustPolicyManager is responsible for storing an internal mapping of server trust policies to a particular host. This allows Alamofire to evaluate each host against a different server trust policy.

+

The ServerTrustPolicyManager is responsible for storing an internal mapping of server trust policies to a particular host. This allows Alamofire to evaluate each host against a different server trust policy.

let serverTrustPolicies: [String: ServerTrustPolicy] = [
     "test.example.com": .pinCertificates(
         certificates: ServerTrustPolicy.certificates(),
@@ -1815,7 +1815,7 @@ 

Server Trust Policy Manager

-

Make sure to keep a reference to the new SessionManager instance, otherwise your requests will all get cancelled when your sessionManager is deallocated.

+

Make sure to keep a reference to the new SessionManager instance, otherwise your requests will all get cancelled when your sessionManager is deallocated.

These server trust policies will result in the following behavior:

@@ -1833,7 +1833,7 @@

Server Trust Policy Manager

Subclassing Server Trust Policy Manager
-

If you find yourself needing more flexible server trust policy matching behavior (i.e. wildcarded domains), then subclass the ServerTrustPolicyManager and override the serverTrustPolicyForHost method with your own custom implementation.

+

If you find yourself needing more flexible server trust policy matching behavior (i.e. wildcarded domains), then subclass the ServerTrustPolicyManager and override the serverTrustPolicyForHost method with your own custom implementation.

class CustomServerTrustPolicyManager: ServerTrustPolicyManager {
     override func serverTrustPolicy(forHost host: String) -> ServerTrustPolicy? {
         var policy: ServerTrustPolicy?
@@ -1862,7 +1862,7 @@ 

Validating the Certifi

App Transport Security

-

With the addition of App Transport Security (ATS) in iOS 9, it is possible that using a custom ServerTrustPolicyManager with several ServerTrustPolicy objects will have no effect. If you continuously see CFNetwork SSLHandshake failed (-9806) errors, you have probably run into this problem. Apple’s ATS system overrides the entire challenge system unless you configure the ATS settings in your app’s plist to disable enough of it to allow your app to evaluate the server trust.

+

With the addition of App Transport Security (ATS) in iOS 9, it is possible that using a custom ServerTrustPolicyManager with several ServerTrustPolicy objects will have no effect. If you continuously see CFNetwork SSLHandshake failed (-9806) errors, you have probably run into this problem. Apple’s ATS system overrides the entire challenge system unless you configure the ATS settings in your app’s plist to disable enough of it to allow your app to evaluate the server trust.

If you run into this problem (high probability with self-signed certificates), you can work around this issue by adding the following to your Info.plist.

<dict>
@@ -1887,14 +1887,14 @@ 

App Transport Security

</dict>
-

Whether you need to set the NSExceptionRequiresForwardSecrecy to NO depends on whether your TLS connection is using an allowed cipher suite. In certain cases, it will need to be set to NO. The NSExceptionAllowsInsecureHTTPLoads MUST be set to YES in order to allow the SessionDelegate to receive challenge callbacks. Once the challenge callbacks are being called, the ServerTrustPolicyManager will take over the server trust evaluation. You may also need to specify the NSTemporaryExceptionMinimumTLSVersion if you’re trying to connect to a host that only supports TLS versions less than 1.2.

+

Whether you need to set the NSExceptionRequiresForwardSecrecy to NO depends on whether your TLS connection is using an allowed cipher suite. In certain cases, it will need to be set to NO. The NSExceptionAllowsInsecureHTTPLoads MUST be set to YES in order to allow the SessionDelegate to receive challenge callbacks. Once the challenge callbacks are being called, the ServerTrustPolicyManager will take over the server trust evaluation. You may also need to specify the NSTemporaryExceptionMinimumTLSVersion if you’re trying to connect to a host that only supports TLS versions less than 1.2.

It is recommended to always use valid certificates in production environments.

Network Reachability

-

The NetworkReachabilityManager listens for reachability changes of hosts and addresses for both WWAN and WiFi network interfaces.

+

The NetworkReachabilityManager listens for reachability changes of hosts and addresses for both WWAN and WiFi network interfaces.

let manager = NetworkReachabilityManager(host: "www.apple.com")
 
 manager?.listener = { status in
@@ -1950,9 +1950,9 @@ 

What’s

Alamofire is named after the Alamo Fire flower, a hybrid variant of the Bluebonnet, the official state flower of Texas.

What logic belongs in a Router vs. a Request Adapter?

-

Simple, static data such as paths, parameters and common headers belong in the Router. Dynamic data such as an Authorization header whose value can changed based on an authentication system belongs in a RequestAdapter.

+

Simple, static data such as paths, parameters and common headers belong in the Router. Dynamic data such as an Authorization header whose value can changed based on an authentication system belongs in a RequestAdapter.

-

The reason the dynamic data MUST be placed into the RequestAdapter is to support retry operations. When a Request is retried, the original request is not rebuilt meaning the Router will not be called again. The RequestAdapter is called again allowing the dynamic data to be updated on the original request before retrying the Request.

+

The reason the dynamic data MUST be placed into the RequestAdapter is to support retry operations. When a Request is retried, the original request is not rebuilt meaning the Router will not be called again. The RequestAdapter is called again allowing the dynamic data to be updated on the original request before retrying the Request.


Credits

diff --git a/document_alamofire/after/docs/index.html b/document_alamofire/after/docs/index.html index fb0e880f3..8dcaf5669 100644 --- a/document_alamofire/after/docs/index.html +++ b/document_alamofire/after/docs/index.html @@ -461,7 +461,7 @@

Making a Request

Response Handling

-

Handling the Response of a Request made in Alamofire involves chaining a response handler onto the Request.

+

Handling the Response of a Request made in Alamofire involves chaining a response handler onto the Request.

Alamofire.request("https://httpbin.org/get").responseJSON { response in
     print(response.request)  // original URL request
     print(response.response) // HTTP URL response
@@ -474,7 +474,7 @@ 

Response Handling

}
-

In the above example, the responseJSON handler is appended to the Request to be executed once the Request is complete. Rather than blocking execution to wait for a response from the server, a callback in the form of a closure is specified to handle the response once it’s received. The result of a request is only available inside the scope of a response closure. Any execution contingent on the response or data received from the server must be done within a response closure.

+

In the above example, the responseJSON handler is appended to the Request to be executed once the Request is complete. Rather than blocking execution to wait for a response from the server, a callback in the form of a closure is specified to handle the response once it’s received. The result of a request is only available inside the scope of a response closure. Any execution contingent on the response or data received from the server must be done within a response closure.

Networking in Alamofire is done asynchronously. Asynchronous programming may be a source of frustration to programmers unfamiliar with the concept, but there are very good reasons for doing it this way.

@@ -520,7 +520,7 @@

Response Handling

Response Handler

-

The response handler does NOT evaluate any of the response data. It merely forwards on all information directly from the URL session delegate. It is the Alamofire equivalent of using cURL to execute a Request.

+

The response handler does NOT evaluate any of the response data. It merely forwards on all information directly from the URL session delegate. It is the Alamofire equivalent of using cURL to execute a Request.

Alamofire.request("https://httpbin.org/get").response { response in
     print("Request: \(response.request)")
     print("Response: \(response.response)")
@@ -533,11 +533,11 @@ 

Response Handler

-

We strongly encourage you to leverage the other response serializers taking advantage of Response and Result types.

+

We strongly encourage you to leverage the other response serializers taking advantage of Response and Result types.

Response Data Handler

-

The responseData handler uses the responseDataSerializer (the object that serializes the server data into some other type) to extract the Data returned by the server. If no errors occur and Data is returned, the response Result will be a .success and the value will be of type Data.

+

The responseData handler uses the responseDataSerializer (the object that serializes the server data into some other type) to extract the Data returned by the server. If no errors occur and Data is returned, the response Result will be a .success and the value will be of type Data.

Alamofire.request("https://httpbin.org/get").responseData { response in
     debugPrint("All Response Info: \(response)")
 
@@ -548,7 +548,7 @@ 

Response Data Handler

Response String Handler

-

The responseString handler uses the responseStringSerializer to convert the Data returned by the server into a String with the specified encoding. If no errors occur and the server data is successfully serialized into a String, the response Result will be a .success and the value will be of type String.

+

The responseString handler uses the responseStringSerializer to convert the Data returned by the server into a String with the specified encoding. If no errors occur and the server data is successfully serialized into a String, the response Result will be a .success and the value will be of type String.

Alamofire.request("https://httpbin.org/get").responseString { response in
     print("Success: \(response.result.isSuccess)")
     print("Response String: \(response.result.value)")
@@ -560,7 +560,7 @@ 

Response String Handler

Response JSON Handler

-

The responseJSON handler uses the responseJSONSerializer to convert the Data returned by the server into an Any type using the specified JSONSerialization.ReadingOptions. If no errors occur and the server data is successfully serialized into a JSON object, the response Result will be a .success and the value will be of type Any.

+

The responseJSON handler uses the responseJSONSerializer to convert the Data returned by the server into an Any type using the specified JSONSerialization.ReadingOptions. If no errors occur and the server data is successfully serialized into a JSON object, the response Result will be a .success and the value will be of type Any.

Alamofire.request("https://httpbin.org/get").responseJSON { response in
     debugPrint(response)
 
@@ -586,7 +586,7 @@ 

Chained Response Handlers

-

It is important to note that using multiple response handlers on the same Request requires the server data to be serialized multiple times. Once for each response handler.

+

It is important to note that using multiple response handlers on the same Request requires the server data to be serialized multiple times. Once for each response handler.

Response Handler Queue

@@ -634,7 +634,7 @@

Response Caching

HTTP Methods

-

The HTTPMethod enumeration lists the HTTP methods defined in RFC 7231 §4.3:

+

The HTTPMethod enumeration lists the HTTP methods defined in RFC 7231 §4.3:

public enum HTTPMethod: String {
     case options = "OPTIONS"
     case get     = "GET"
@@ -661,10 +661,10 @@ 

HTTP Methods

Parameter Encoding

-

Alamofire supports three types of parameter encoding including: URL, JSON and PropertyList. It can also support any custom encoding that conforms to the ParameterEncoding protocol.

+

Alamofire supports three types of parameter encoding including: URL, JSON and PropertyList. It can also support any custom encoding that conforms to the ParameterEncoding protocol.

URL Encoding

-

The URLEncoding type creates a url-encoded query string to be set as or appended to any existing URL query string or set as the HTTP body of the URL request. Whether the query string is set or appended to any existing URL query string or set as the HTTP body depends on the Destination of the encoding. The Destination enumeration has three cases:

+

The URLEncoding type creates a url-encoded query string to be set as or appended to any existing URL query string or set as the HTTP body of the URL request. Whether the query string is set or appended to any existing URL query string or set as the HTTP body depends on the Destination of the encoding. The Destination enumeration has three cases:

  • .methodDependent - Applies encoded query string result to existing query string for GET, HEAD and DELETE requests and sets as the HTTP body for requests with any other HTTP method.
  • @@ -703,7 +703,7 @@
    POST Request W

JSON Encoding

-

The JSONEncoding type creates a JSON representation of the parameters object, which is set as the HTTP body of the request. The Content-Type HTTP header field of an encoded request is set to application/json.

+

The JSONEncoding type creates a JSON representation of the parameters object, which is set as the HTTP body of the request. The Content-Type HTTP header field of an encoded request is set to application/json.

POST Request with JSON-Encoded Parameters
let parameters: Parameters = [
     "foo": [1,2,3],
@@ -720,10 +720,10 @@ 
POST Request

Property List Encoding

-

The PropertyListEncoding uses PropertyListSerialization 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 Content-Type HTTP header field of an encoded request is set to application/x-plist.

+

The PropertyListEncoding uses PropertyListSerialization 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 Content-Type HTTP header field of an encoded request is set to application/x-plist.

Custom Encoding

-

In the event that the provided ParameterEncoding types do not meet your needs, you can create your own custom encoding. Here’s a quick example of how you could build a custom JSONStringArrayEncoding type to encode a JSON string array onto a Request.

+

In the event that the provided ParameterEncoding types do not meet your needs, you can create your own custom encoding. Here’s a quick example of how you could build a custom JSONStringArrayEncoding type to encode a JSON string array onto a Request.

struct JSONStringArrayEncoding: ParameterEncoding {
     private let array: [String]
 
@@ -748,7 +748,7 @@ 

Custom Encoding

Manual Parameter Encoding of a URLRequest

-

The ParameterEncoding APIs can be used outside of making network requests.

+

The ParameterEncoding APIs can be used outside of making network requests.

let url = URL(string: "https://httpbin.org/get")!
 var urlRequest = URLRequest(url: url)
 
@@ -757,7 +757,7 @@ 

Manual Parame

HTTP Headers

-

Adding a custom HTTP header to a Request is supported directly in the global request method. This makes it easy to attach HTTP headers to a Request that can be constantly changing.

+

Adding a custom HTTP header to a Request is supported directly in the global request method. This makes it easy to attach HTTP headers to a Request that can be constantly changing.

let headers: HTTPHeaders = [
     "Authorization": "Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==",
     "Accept": "application/json"
@@ -772,7 +772,7 @@ 

HTTP Headers

For HTTP headers that do not change, it is recommended to set them on the URLSessionConfiguration so they are automatically applied to any URLSessionTask created by the underlying URLSession. For more information, see the Session Manager Configurations section.

-

The default Alamofire SessionManager provides a default set of headers for every Request. These include:

+

The default Alamofire SessionManager provides a default set of headers for every Request. These include:

  • Accept-Encoding, which defaults to gzip;q=1.0, compress;q=0.5, per RFC 7230 §4.2.3.
  • @@ -780,7 +780,7 @@

    HTTP Headers

  • User-Agent, which contains versioning information about the current app. For example: iOS Example/1.0 (com.alamofire.iOS-Example; build:1; iOS 10.0.0) Alamofire/4.0.0, per RFC 7231 §5.5.3.
-

If you need to customize these headers, a custom URLSessionConfiguration should be created, the defaultHTTPHeaders property updated and the configuration applied to a new SessionManager instance.

+

If you need to customize these headers, a custom URLSessionConfiguration should be created, the defaultHTTPHeaders property updated and the configuration applied to a new SessionManager instance.

Authentication

Authentication is handled on the system framework level by URLCredential and URLAuthenticationChallenge.

@@ -795,7 +795,7 @@

Authentication

HTTP Basic Authentication

-

The authenticate method on a Request will automatically provide a URLCredential to a URLAuthenticationChallenge when appropriate:

+

The authenticate method on a Request will automatically provide a URLCredential to a URLAuthenticationChallenge when appropriate:

let user = "user"
 let password = "password"
 
@@ -884,7 +884,7 @@ 

Download File Destination

Download Progress

-

Many times it can be helpful to report download progress to the user. Any DownloadRequest can report download progress using the downloadProgress API.

+

Many times it can be helpful to report download progress to the user. Any DownloadRequest can report download progress using the downloadProgress API.

Alamofire.download("https://httpbin.org/image/png")
     .downloadProgress { progress in
         print("Download Progress: \(progress.fractionCompleted)")
@@ -911,7 +911,7 @@ 

Download Progress

Resuming a Download

-

If a DownloadRequest is cancelled or interrupted, the underlying URL session may generate resume data for the active DownloadRequest. If this happens, the resume data can be re-used to restart the DownloadRequest where it left off. The resume data can be accessed through the download response, then reused when trying to restart the request.

+

If a DownloadRequest is cancelled or interrupted, the underlying URL session may generate resume data for the active DownloadRequest. If this happens, the resume data can be re-used to restart the DownloadRequest where it left off. The resume data can be accessed through the download response, then reused when trying to restart the request.

IMPORTANT: On the latest release of all the Apple platforms (iOS 10, macOS 10.12, tvOS 10, watchOS 3), resumeData is broken on background URL session configurations. There’s an underlying bug in the resumeData generation logic where the data is written incorrectly and will always fail to resume the download. For more information about the bug and possible workarounds, please see this Stack Overflow post.

@@ -991,7 +991,7 @@

Uploading Multipart Form

Upload Progress

-

While your user is waiting for their upload to complete, sometimes it can be handy to show the progress of the upload to the user. Any UploadRequest can report both upload progress and download progress of the response data using the uploadProgress and downloadProgress APIs.

+

While your user is waiting for their upload to complete, sometimes it can be handy to show the progress of the upload to the user. Any UploadRequest can report both upload progress and download progress of the response data using the uploadProgress and downloadProgress APIs.

let fileURL = Bundle.main.url(forResource: "video", withExtension: "mov")
 
 Alamofire.upload(fileURL, to: "https://httpbin.org/post")
@@ -1008,13 +1008,13 @@ 

Upload Progress

Statistical Metrics

Timeline

-

Alamofire collects timings throughout the lifecycle of a Request and creates a Timeline object exposed as a property on all response types.

+

Alamofire collects timings throughout the lifecycle of a Request and creates a Timeline object exposed as a property on all response types.

Alamofire.request("https://httpbin.org/get").responseJSON { response in
     print(response.timeline)
 }
 
-

The above reports the following Timeline info:

+

The above reports the following Timeline info:

  • Latency: 0.428 seconds
  • @@ -1024,7 +1024,7 @@

    Timeline

URL Session Task Metrics

-

In iOS and tvOS 10 and macOS 10.12, Apple introduced the new URLSessionTaskMetrics APIs. The task metrics encapsulate some fantastic statistical information about the request and response execution. The API is very similar to the Timeline, but provides many more statistics that Alamofire doesn’t have access to compute. The metrics can be accessed through any response type.

+

In iOS and tvOS 10 and macOS 10.12, Apple introduced the new URLSessionTaskMetrics APIs. The task metrics encapsulate some fantastic statistical information about the request and response execution. The API is very similar to the Timeline, but provides many more statistics that Alamofire doesn’t have access to compute. The metrics can be accessed through any response type.

Alamofire.request("https://httpbin.org/get").responseJSON { response in
     print(response.metrics)
 }
@@ -1039,7 +1039,7 @@ 

URL Session Task Metrics

cURL Command Output

-

Debugging platform issues can be frustrating. Thankfully, Alamofire Request objects conform to both the CustomStringConvertible and CustomDebugStringConvertible protocols to provide some VERY helpful debugging tools.

+

Debugging platform issues can be frustrating. Thankfully, Alamofire Request objects conform to both the CustomStringConvertible and CustomDebugStringConvertible protocols to provide some VERY helpful debugging tools.

CustomStringConvertible

let request = Alamofire.request("https://httpbin.org/ip")
 
@@ -1107,14 +1107,14 @@ 

Modifying the Sessi

-

This is not recommended for Authorization or Content-Type headers. Instead, use the headers parameter in the top-level Alamofire.request APIs, URLRequestConvertible and ParameterEncoding, respectively.

+

This is not recommended for Authorization or Content-Type headers. Instead, use the headers parameter in the top-level Alamofire.request APIs, URLRequestConvertible and ParameterEncoding, respectively.

Session Delegate

-

By default, an Alamofire SessionManager instance creates a SessionDelegate object to handle all the various types of delegate callbacks that are generated by the underlying URLSession. The implementations of each delegate method handle the most common use cases for these types of calls abstracting the complexity away from the top-level APIs. However, advanced users may find the need to override the default functionality for various reasons.

+

By default, an Alamofire SessionManager instance creates a SessionDelegate object to handle all the various types of delegate callbacks that are generated by the underlying URLSession. The implementations of each delegate method handle the most common use cases for these types of calls abstracting the complexity away from the top-level APIs. However, advanced users may find the need to override the default functionality for various reasons.

Override Closures

-

The first way to customize the SessionDelegate behavior is through the use of the override closures. Each closure gives you the ability to override the implementation of the matching SessionDelegate API, yet still use the default implementation for all other APIs. This makes it easy to customize subsets of the delegate functionality. Here are a few examples of some of the override closures available:

+

The first way to customize the SessionDelegate behavior is through the use of the override closures. Each closure gives you the ability to override the implementation of the matching SessionDelegate API, yet still use the default implementation for all other APIs. This makes it easy to customize subsets of the delegate functionality. Here are a few examples of some of the override closures available:

/// Overrides default behavior for URLSessionDelegate method `urlSession(_:didReceive:completionHandler:)`.
 open var sessionDidReceiveChallenge: ((URLSession, URLAuthenticationChallenge) -> (URLSession.AuthChallengeDisposition, URLCredential?))?
 
@@ -1148,7 +1148,7 @@ 

Override Closures

Subclassing

-

Another way to override the default implementation of the SessionDelegate is to subclass it. Subclassing allows you completely customize the behavior of the API or to create a proxy for the API and still use the default implementation. Creating a proxy allows you to log events, emit notifications, provide pre and post hook implementations, etc. Here’s a quick example of subclassing the SessionDelegate and logging a message when a redirect occurs.

+

Another way to override the default implementation of the SessionDelegate is to subclass it. Subclassing allows you completely customize the behavior of the API or to create a proxy for the API and still use the default implementation. Creating a proxy allows you to log events, emit notifications, provide pre and post hook implementations, etc. Here’s a quick example of subclassing the SessionDelegate and logging a message when a redirect occurs.

class LoggingSessionDelegate: SessionDelegate {
     override func urlSession(
         _ session: URLSession,
@@ -1177,7 +1177,7 @@ 

Subclassing

Request

-

The result of a request, download, upload or stream methods are a DataRequest, DownloadRequest, UploadRequest and StreamRequest which all inherit from Request. All Request instances are always created by an owning session manager, and never initialized directly.

+

The result of a request, download, upload or stream methods are a DataRequest, DownloadRequest, UploadRequest and StreamRequest which all inherit from Request. All Request instances are always created by an owning session manager, and never initialized directly.

Each subclass has specialized methods such as authenticate, validate, responseJSON and uploadProgress that each return the caller instance in order to facilitate method chaining.

@@ -1190,10 +1190,10 @@

Request

Routing Requests

-

As apps grow in size, it’s important to adopt common patterns as you build out your network stack. An important part of that design is how to route your requests. The Alamofire URLConvertible and URLRequestConvertible protocols along with the Router design pattern are here to help.

+

As apps grow in size, it’s important to adopt common patterns as you build out your network stack. An important part of that design is how to route your requests. The Alamofire URLConvertible and URLRequestConvertible protocols along with the Router design pattern are here to help.

URLConvertible

-

Types adopting the URLConvertible protocol can be used to construct URLs, which are then used to construct URL requests internally. String, URL, and URLComponents conform to URLConvertible by default, allowing any of them to be passed as url parameters to the request, upload, and download methods:

+

Types adopting the URLConvertible protocol can be used to construct URLs, which are then used to construct URL requests internally. String, URL, and URLComponents conform to URLConvertible by default, allowing any of them to be passed as url parameters to the request, upload, and download methods:

let urlString = "https://httpbin.org/post"
 Alamofire.request(urlString, method: .post)
 
@@ -1204,7 +1204,7 @@ 

URLConvertible

Alamofire.request(urlComponents, method: .post)
-

Applications interacting with web applications in a significant manner are encouraged to have custom types conform to URLConvertible as a convenient way to map domain-specific models to server resources.

+

Applications interacting with web applications in a significant manner are encouraged to have custom types conform to URLConvertible as a convenient way to map domain-specific models to server resources.

Type-Safe Routing
extension User: URLConvertible {
     static let baseURLString = "https://example.com"
@@ -1220,7 +1220,7 @@ 
Type-Safe Routing

URLRequestConvertible

-

Types adopting the URLRequestConvertible protocol can be used to construct URL requests. URLRequest conforms to URLRequestConvertible by default, allowing it to be passed into request, upload, and download methods directly (this is the recommended way to specify custom HTTP body for individual requests):

+

Types adopting the URLRequestConvertible protocol can be used to construct URL requests. URLRequest conforms to URLRequestConvertible by default, allowing it to be passed into request, upload, and download methods directly (this is the recommended way to specify custom HTTP body for individual requests):

let url = URL(string: "https://httpbin.org/post")!
 var urlRequest = URLRequest(url: url)
 urlRequest.httpMethod = "POST"
@@ -1238,7 +1238,7 @@ 

URLRequestConvertible

Alamofire.request(urlRequest)
-

Applications interacting with web applications in a significant manner are encouraged to have custom types conform to URLRequestConvertible as a way to ensure consistency of requested endpoints. Such an approach can be used to abstract away server-side inconsistencies and provide type-safe routing, as well as manage authentication credentials and other state.

+

Applications interacting with web applications in a significant manner are encouraged to have custom types conform to URLRequestConvertible as a way to ensure consistency of requested endpoints. Such an approach can be used to abstract away server-side inconsistencies and provide type-safe routing, as well as manage authentication credentials and other state.

API Parameter Abstraction
enum Router: URLRequestConvertible {
     case search(query: String, page: Int)
@@ -1331,10 +1331,10 @@ 

Adapting and Retrying Re

Most web services these days are behind some sort of authentication system. One of the more common ones today is OAuth. This generally involves generating an access token authorizing your application or user to call the various supported web services. While creating these initial access tokens can be laborsome, it can be even more complicated when your access token expires and you need to fetch a new one. There are many thread-safety issues that need to be considered.

-

The RequestAdapter and RequestRetrier protocols were created to make it much easier to create a thread-safe authentication system for a specific set of web services.

+

The RequestAdapter and RequestRetrier protocols were created to make it much easier to create a thread-safe authentication system for a specific set of web services.

RequestAdapter

-

The RequestAdapter protocol allows each Request made on a SessionManager to be inspected and adapted before being created. One very specific way to use an adapter is to append an Authorization header to requests behind a certain type of authentication.

+

The RequestAdapter protocol allows each Request made on a SessionManager to be inspected and adapted before being created. One very specific way to use an adapter is to append an Authorization header to requests behind a certain type of authentication.

class AccessTokenAdapter: RequestAdapter {
     private let accessToken: String
 
@@ -1360,10 +1360,10 @@ 

RequestAdapter

RequestRetrier

-

The RequestRetrier protocol allows a Request that encountered an Error while being executed to be retried. When using both the RequestAdapter and RequestRetrier protocols together, you can create credential refresh systems for OAuth1, OAuth2, Basic Auth and even exponential backoff retry policies. The possibilities are endless. Here’s an example of how you could implement a refresh flow for OAuth2 access tokens.

+

The RequestRetrier protocol allows a Request that encountered an Error while being executed to be retried. When using both the RequestAdapter and RequestRetrier protocols together, you can create credential refresh systems for OAuth1, OAuth2, Basic Auth and even exponential backoff retry policies. The possibilities are endless. Here’s an example of how you could implement a refresh flow for OAuth2 access tokens.

-

DISCLAIMER: This is NOT a global OAuth2 solution. It is merely an example demonstrating how one could use the RequestAdapter in conjunction with the RequestRetrier to create a thread-safe refresh system.

+

DISCLAIMER: This is NOT a global OAuth2 solution. It is merely an example demonstrating how one could use the RequestAdapter in conjunction with the RequestRetrier to create a thread-safe refresh system.

To reiterate, do NOT copy this sample code and drop it into a production application. This is merely an example. Each authentication system must be tailored to a particular platform and authentication type.

@@ -1491,7 +1491,7 @@

RequestRetrier

}
-

Once the OAuth2Handler is applied as both the adapter and retrier for the SessionManager, it will handle an invalid access token error by automatically refreshing the access token and retrying all failed requests in the same order they failed.

+

Once the OAuth2Handler is applied as both the adapter and retrier for the SessionManager, it will handle an invalid access token error by automatically refreshing the access token and retrying all failed requests in the same order they failed.

If you needed them to execute in the same order they were created, you could sort them by their task identifiers.

@@ -1521,7 +1521,7 @@

Custom Response Serializa

Response Mapping

-

Response mapping is the simplest way to produce customized responses. It transforms the value of a response, while preserving eventual errors and meta-data. For example, you can turn a json response DataResponse<Any> into a response that holds an application model, such as DataResponse<User>. You perform response mapping with the DataResponse.map method:

+

Response mapping is the simplest way to produce customized responses. It transforms the value of a response, while preserving eventual errors and meta-data. For example, you can turn a json response DataResponse<Any> into a response that holds an application model, such as DataResponse<User>. You perform response mapping with the DataResponse.map method:

Alamofire.request("https://example.com/users/mattt").responseJSON { (response: DataResponse<Any>) in
     let userResponse = response.map { json in
         // We assume an existing User(json: Any) initializer
@@ -1777,10 +1777,10 @@ 

Generic Response

Security

-

Using a secure HTTPS connection when communicating with servers and web services is an important step in securing sensitive data. By default, Alamofire will evaluate the certificate chain provided by the server using Apple’s built in validation provided by the Security framework. While this guarantees the certificate chain is valid, it does not prevent man-in-the-middle (MITM) attacks or other potential vulnerabilities. In order to mitigate MITM attacks, applications dealing with sensitive customer data or financial information should use certificate or public key pinning provided by the ServerTrustPolicy.

+

Using a secure HTTPS connection when communicating with servers and web services is an important step in securing sensitive data. By default, Alamofire will evaluate the certificate chain provided by the server using Apple’s built in validation provided by the Security framework. While this guarantees the certificate chain is valid, it does not prevent man-in-the-middle (MITM) attacks or other potential vulnerabilities. In order to mitigate MITM attacks, applications dealing with sensitive customer data or financial information should use certificate or public key pinning provided by the ServerTrustPolicy.

ServerTrustPolicy

-

The ServerTrustPolicy enumeration evaluates the server trust generally provided by an URLAuthenticationChallenge when connecting to a server over a secure HTTPS connection.

+

The ServerTrustPolicy enumeration evaluates the server trust generally provided by an URLAuthenticationChallenge when connecting to a server over a secure HTTPS connection.

let serverTrustPolicy = ServerTrustPolicy.pinCertificates(
     certificates: ServerTrustPolicy.certificates(),
     validateCertificateChain: true,
@@ -1799,7 +1799,7 @@ 

ServerTrustPolicy

Server Trust Policy Manager

-

The ServerTrustPolicyManager is responsible for storing an internal mapping of server trust policies to a particular host. This allows Alamofire to evaluate each host against a different server trust policy.

+

The ServerTrustPolicyManager is responsible for storing an internal mapping of server trust policies to a particular host. This allows Alamofire to evaluate each host against a different server trust policy.

let serverTrustPolicies: [String: ServerTrustPolicy] = [
     "test.example.com": .pinCertificates(
         certificates: ServerTrustPolicy.certificates(),
@@ -1815,7 +1815,7 @@ 

Server Trust Policy Manager

-

Make sure to keep a reference to the new SessionManager instance, otherwise your requests will all get cancelled when your sessionManager is deallocated.

+

Make sure to keep a reference to the new SessionManager instance, otherwise your requests will all get cancelled when your sessionManager is deallocated.

These server trust policies will result in the following behavior:

@@ -1833,7 +1833,7 @@

Server Trust Policy Manager

Subclassing Server Trust Policy Manager
-

If you find yourself needing more flexible server trust policy matching behavior (i.e. wildcarded domains), then subclass the ServerTrustPolicyManager and override the serverTrustPolicyForHost method with your own custom implementation.

+

If you find yourself needing more flexible server trust policy matching behavior (i.e. wildcarded domains), then subclass the ServerTrustPolicyManager and override the serverTrustPolicyForHost method with your own custom implementation.

class CustomServerTrustPolicyManager: ServerTrustPolicyManager {
     override func serverTrustPolicy(forHost host: String) -> ServerTrustPolicy? {
         var policy: ServerTrustPolicy?
@@ -1862,7 +1862,7 @@ 

Validating the Certifi

App Transport Security

-

With the addition of App Transport Security (ATS) in iOS 9, it is possible that using a custom ServerTrustPolicyManager with several ServerTrustPolicy objects will have no effect. If you continuously see CFNetwork SSLHandshake failed (-9806) errors, you have probably run into this problem. Apple’s ATS system overrides the entire challenge system unless you configure the ATS settings in your app’s plist to disable enough of it to allow your app to evaluate the server trust.

+

With the addition of App Transport Security (ATS) in iOS 9, it is possible that using a custom ServerTrustPolicyManager with several ServerTrustPolicy objects will have no effect. If you continuously see CFNetwork SSLHandshake failed (-9806) errors, you have probably run into this problem. Apple’s ATS system overrides the entire challenge system unless you configure the ATS settings in your app’s plist to disable enough of it to allow your app to evaluate the server trust.

If you run into this problem (high probability with self-signed certificates), you can work around this issue by adding the following to your Info.plist.

<dict>
@@ -1887,14 +1887,14 @@ 

App Transport Security

</dict>
-

Whether you need to set the NSExceptionRequiresForwardSecrecy to NO depends on whether your TLS connection is using an allowed cipher suite. In certain cases, it will need to be set to NO. The NSExceptionAllowsInsecureHTTPLoads MUST be set to YES in order to allow the SessionDelegate to receive challenge callbacks. Once the challenge callbacks are being called, the ServerTrustPolicyManager will take over the server trust evaluation. You may also need to specify the NSTemporaryExceptionMinimumTLSVersion if you’re trying to connect to a host that only supports TLS versions less than 1.2.

+

Whether you need to set the NSExceptionRequiresForwardSecrecy to NO depends on whether your TLS connection is using an allowed cipher suite. In certain cases, it will need to be set to NO. The NSExceptionAllowsInsecureHTTPLoads MUST be set to YES in order to allow the SessionDelegate to receive challenge callbacks. Once the challenge callbacks are being called, the ServerTrustPolicyManager will take over the server trust evaluation. You may also need to specify the NSTemporaryExceptionMinimumTLSVersion if you’re trying to connect to a host that only supports TLS versions less than 1.2.

It is recommended to always use valid certificates in production environments.

Network Reachability

-

The NetworkReachabilityManager listens for reachability changes of hosts and addresses for both WWAN and WiFi network interfaces.

+

The NetworkReachabilityManager listens for reachability changes of hosts and addresses for both WWAN and WiFi network interfaces.

let manager = NetworkReachabilityManager(host: "www.apple.com")
 
 manager?.listener = { status in
@@ -1950,9 +1950,9 @@ 

What’s

Alamofire is named after the Alamo Fire flower, a hybrid variant of the Bluebonnet, the official state flower of Texas.

What logic belongs in a Router vs. a Request Adapter?

-

Simple, static data such as paths, parameters and common headers belong in the Router. Dynamic data such as an Authorization header whose value can changed based on an authentication system belongs in a RequestAdapter.

+

Simple, static data such as paths, parameters and common headers belong in the Router. Dynamic data such as an Authorization header whose value can changed based on an authentication system belongs in a RequestAdapter.

-

The reason the dynamic data MUST be placed into the RequestAdapter is to support retry operations. When a Request is retried, the original request is not rebuilt meaning the Router will not be called again. The RequestAdapter is called again allowing the dynamic data to be updated on the original request before retrying the Request.

+

The reason the dynamic data MUST be placed into the RequestAdapter is to support retry operations. When a Request is retried, the original request is not rebuilt meaning the Router will not be called again. The RequestAdapter is called again allowing the dynamic data to be updated on the original request before retrying the Request.


Credits

diff --git a/document_moya_podspec/after/docs/Classes/Endpoint.html b/document_moya_podspec/after/docs/Classes/Endpoint.html index 20946a0d4..dbf89210e 100644 --- a/document_moya_podspec/after/docs/Classes/Endpoint.html +++ b/document_moya_podspec/after/docs/Classes/Endpoint.html @@ -577,37 +577,6 @@

Declaration

-
-

Parameters

- - - - - - - - - - - -
- - lhs - - -
- -
-
- - rhs - - -
- -
-
-
diff --git a/document_moya_podspec/after/docs/Classes/Response.html b/document_moya_podspec/after/docs/Classes/Response.html index 65e662d58..0df735fc0 100644 --- a/document_moya_podspec/after/docs/Classes/Response.html +++ b/document_moya_podspec/after/docs/Classes/Response.html @@ -403,37 +403,6 @@

Declaration

-
-

Parameters

- - - - - - - - - - - -
- - lhs - - -
- -
-
- - rhs - - -
- -
-
-
diff --git a/document_moya_podspec/after/docs/docsets/Moya.docset/Contents/Resources/Documents/Classes/Endpoint.html b/document_moya_podspec/after/docs/docsets/Moya.docset/Contents/Resources/Documents/Classes/Endpoint.html index 20946a0d4..dbf89210e 100644 --- a/document_moya_podspec/after/docs/docsets/Moya.docset/Contents/Resources/Documents/Classes/Endpoint.html +++ b/document_moya_podspec/after/docs/docsets/Moya.docset/Contents/Resources/Documents/Classes/Endpoint.html @@ -577,37 +577,6 @@

Declaration

-
-

Parameters

- - - - - - - - - - - -
- - lhs - - -
- -
-
- - rhs - - -
- -
-
-
diff --git a/document_moya_podspec/after/docs/docsets/Moya.docset/Contents/Resources/Documents/Classes/Response.html b/document_moya_podspec/after/docs/docsets/Moya.docset/Contents/Resources/Documents/Classes/Response.html index 65e662d58..0df735fc0 100644 --- a/document_moya_podspec/after/docs/docsets/Moya.docset/Contents/Resources/Documents/Classes/Response.html +++ b/document_moya_podspec/after/docs/docsets/Moya.docset/Contents/Resources/Documents/Classes/Response.html @@ -403,37 +403,6 @@

Declaration

-
-

Parameters

- - - - - - - - - - - -
- - lhs - - -
- -
-
- - rhs - - -
- -
-
-
diff --git a/document_realm_objc/after/docs/Classes/RLMArray.html b/document_realm_objc/after/docs/Classes/RLMArray.html index d06a44cb3..e806117e4 100644 --- a/document_realm_objc/after/docs/Classes/RLMArray.html +++ b/document_realm_objc/after/docs/Classes/RLMArray.html @@ -714,7 +714,7 @@

Parameters

-

An RLMObject of the type contained in the array.

+

An RLMObject of the type contained in the array.

@@ -773,7 +773,7 @@

Parameters

-

An enumerable object such as NSArray or RLMResults which contains objects of the +

An enumerable object such as NSArray or RLMResults which contains objects of the same class as the array.

@@ -835,7 +835,7 @@

Parameters

-

An RLMObject of the type contained in the array.

+

An RLMObject of the type contained in the array.

@@ -1062,7 +1062,7 @@

Parameters

-

An object (of the same type as returned from the objectClassName selector).

+

An object (of the same type as returned from the objectClassName selector).

@@ -1277,7 +1277,7 @@

Parameters

-

An object (of the same type as returned from the objectClassName selector).

+

An object (of the same type as returned from the objectClassName selector).

@@ -1700,7 +1700,7 @@

Parameters

-

An array of RLMSortDescriptors to sort by.

+

An array of RLMSortDescriptors to sort by.

diff --git a/document_realm_objc/after/docs/Classes/RLMMigration.html b/document_realm_objc/after/docs/Classes/RLMMigration.html index d331c50eb..3632eb921 100644 --- a/document_realm_objc/after/docs/Classes/RLMMigration.html +++ b/document_realm_objc/after/docs/Classes/RLMMigration.html @@ -475,7 +475,7 @@

Parameters

-

The name of the RLMObject class to enumerate.

+

The name of the RLMObject class to enumerate.

@@ -538,7 +538,7 @@

Parameters

-

The name of the RLMObject class to create.

+

The name of the RLMObject class to create.

@@ -663,7 +663,7 @@

Parameters

-

The name of the RLMObject class to delete.

+

The name of the RLMObject class to delete.

diff --git a/document_realm_objc/after/docs/Classes/RLMRealm.html b/document_realm_objc/after/docs/Classes/RLMRealm.html index 06785274a..615e82813 100644 --- a/document_realm_objc/after/docs/Classes/RLMRealm.html +++ b/document_realm_objc/after/docs/Classes/RLMRealm.html @@ -1826,7 +1826,7 @@

Parameters

-

An enumerable object such as NSArray or RLMResults which contains objects to be added to +

An enumerable object such as NSArray or RLMResults which contains objects to be added to the Realm.

@@ -1960,7 +1960,7 @@

Parameters

-

An NSArray, RLMArray, or RLMResults of RLMObjects (or subclasses) to be added to the Realm.

+

An NSArray, RLMArray, or RLMResults of RLMObjects (or subclasses) to be added to the Realm.

@@ -2085,7 +2085,7 @@

Parameters

-

An RLMArray, NSArray, or RLMResults of RLMObjects (or subclasses) to be deleted.

+

An RLMArray, NSArray, or RLMResults of RLMObjects (or subclasses) to be deleted.

diff --git a/document_realm_objc/after/docs/Classes/RLMResults.html b/document_realm_objc/after/docs/Classes/RLMResults.html index bbfb5373e..9c3e3bbd8 100644 --- a/document_realm_objc/after/docs/Classes/RLMResults.html +++ b/document_realm_objc/after/docs/Classes/RLMResults.html @@ -708,7 +708,7 @@

Parameters

-

An object (of the same type as returned from the objectClassName selector).

+

An object (of the same type as returned from the objectClassName selector).

@@ -1131,7 +1131,7 @@

Parameters

-

An array of RLMSortDescriptors to sort by.

+

An array of RLMSortDescriptors to sort by.

diff --git a/document_realm_objc/after/docs/Classes/RLMSyncConfiguration.html b/document_realm_objc/after/docs/Classes/RLMSyncConfiguration.html index f440acc55..1813a2db7 100644 --- a/document_realm_objc/after/docs/Classes/RLMSyncConfiguration.html +++ b/document_realm_objc/after/docs/Classes/RLMSyncConfiguration.html @@ -490,7 +490,7 @@

Parameters

-

A RLMSyncUser that owns the Realm at the given URL.

+

A RLMSyncUser that owns the Realm at the given URL.

diff --git a/document_realm_objc/after/docs/Classes/RLMSyncPermissionChange.html b/document_realm_objc/after/docs/Classes/RLMSyncPermissionChange.html index 1bc226383..d964e5cac 100644 --- a/document_realm_objc/after/docs/Classes/RLMSyncPermissionChange.html +++ b/document_realm_objc/after/docs/Classes/RLMSyncPermissionChange.html @@ -769,7 +769,7 @@

Parameters

The Realm URL whose permissions settings should be changed. - Use * to change the permissions of all Realms managed by the Management Realm’s RLMSyncUser.

+ Use * to change the permissions of all Realms managed by the Management Realm’s RLMSyncUser.

diff --git a/document_realm_objc/after/docs/Classes/RLMSyncPermissionOfferResponse.html b/document_realm_objc/after/docs/Classes/RLMSyncPermissionOfferResponse.html index 85aa026a2..e10b3a0f9 100644 --- a/document_realm_objc/after/docs/Classes/RLMSyncPermissionOfferResponse.html +++ b/document_realm_objc/after/docs/Classes/RLMSyncPermissionOfferResponse.html @@ -664,7 +664,7 @@

Parameters

The received token which uniquely identifies another user’s - RLMSyncPermissionOffer.

+ RLMSyncPermissionOffer.

diff --git a/document_realm_objc/after/docs/Classes/RLMSyncPermissionValue.html b/document_realm_objc/after/docs/Classes/RLMSyncPermissionValue.html index 10fc7295b..11bd32085 100644 --- a/document_realm_objc/after/docs/Classes/RLMSyncPermissionValue.html +++ b/document_realm_objc/after/docs/Classes/RLMSyncPermissionValue.html @@ -568,7 +568,7 @@

Parameters

-

The identity of the user who should be granted access to the Realm at path. +

The identity of the user who should be granted access to the Realm at path. Pass * to apply to all users managed by the server.

diff --git a/document_realm_objc/after/docs/Protocols/RLMCollection.html b/document_realm_objc/after/docs/Protocols/RLMCollection.html index 8b5ba02c4..fe5eb0325 100644 --- a/document_realm_objc/after/docs/Protocols/RLMCollection.html +++ b/document_realm_objc/after/docs/Protocols/RLMCollection.html @@ -652,7 +652,7 @@

Parameters

-

An object (of the same type as returned from the objectClassName selector).

+

An object (of the same type as returned from the objectClassName selector).

@@ -1071,7 +1071,7 @@

Parameters

-

An array of RLMSortDescriptors to sort by.

+

An array of RLMSortDescriptors to sort by.

diff --git a/document_realm_objc/after/docs/Type Definitions.html b/document_realm_objc/after/docs/Type Definitions.html index 2d79c57de..09de8a792 100644 --- a/document_realm_objc/after/docs/Type Definitions.html +++ b/document_realm_objc/after/docs/Type Definitions.html @@ -620,7 +620,7 @@

Parameters

-

A RLMMigration object used to perform the migration. The +

A RLMMigration object used to perform the migration. The migration object allows you to enumerate and alter any existing objects which require migration.

diff --git a/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMArray.html b/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMArray.html index d06a44cb3..e806117e4 100644 --- a/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMArray.html +++ b/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMArray.html @@ -714,7 +714,7 @@

Parameters

-

An RLMObject of the type contained in the array.

+

An RLMObject of the type contained in the array.

@@ -773,7 +773,7 @@

Parameters

-

An enumerable object such as NSArray or RLMResults which contains objects of the +

An enumerable object such as NSArray or RLMResults which contains objects of the same class as the array.

@@ -835,7 +835,7 @@

Parameters

-

An RLMObject of the type contained in the array.

+

An RLMObject of the type contained in the array.

@@ -1062,7 +1062,7 @@

Parameters

-

An object (of the same type as returned from the objectClassName selector).

+

An object (of the same type as returned from the objectClassName selector).

@@ -1277,7 +1277,7 @@

Parameters

-

An object (of the same type as returned from the objectClassName selector).

+

An object (of the same type as returned from the objectClassName selector).

@@ -1700,7 +1700,7 @@

Parameters

-

An array of RLMSortDescriptors to sort by.

+

An array of RLMSortDescriptors to sort by.

diff --git a/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMMigration.html b/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMMigration.html index d331c50eb..3632eb921 100644 --- a/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMMigration.html +++ b/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMMigration.html @@ -475,7 +475,7 @@

Parameters

-

The name of the RLMObject class to enumerate.

+

The name of the RLMObject class to enumerate.

@@ -538,7 +538,7 @@

Parameters

-

The name of the RLMObject class to create.

+

The name of the RLMObject class to create.

@@ -663,7 +663,7 @@

Parameters

-

The name of the RLMObject class to delete.

+

The name of the RLMObject class to delete.

diff --git a/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMRealm.html b/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMRealm.html index 06785274a..615e82813 100644 --- a/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMRealm.html +++ b/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMRealm.html @@ -1826,7 +1826,7 @@

Parameters

-

An enumerable object such as NSArray or RLMResults which contains objects to be added to +

An enumerable object such as NSArray or RLMResults which contains objects to be added to the Realm.

@@ -1960,7 +1960,7 @@

Parameters

-

An NSArray, RLMArray, or RLMResults of RLMObjects (or subclasses) to be added to the Realm.

+

An NSArray, RLMArray, or RLMResults of RLMObjects (or subclasses) to be added to the Realm.

@@ -2085,7 +2085,7 @@

Parameters

-

An RLMArray, NSArray, or RLMResults of RLMObjects (or subclasses) to be deleted.

+

An RLMArray, NSArray, or RLMResults of RLMObjects (or subclasses) to be deleted.

diff --git a/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMResults.html b/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMResults.html index bbfb5373e..9c3e3bbd8 100644 --- a/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMResults.html +++ b/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMResults.html @@ -708,7 +708,7 @@

Parameters

-

An object (of the same type as returned from the objectClassName selector).

+

An object (of the same type as returned from the objectClassName selector).

@@ -1131,7 +1131,7 @@

Parameters

-

An array of RLMSortDescriptors to sort by.

+

An array of RLMSortDescriptors to sort by.

diff --git a/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMSyncConfiguration.html b/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMSyncConfiguration.html index f440acc55..1813a2db7 100644 --- a/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMSyncConfiguration.html +++ b/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMSyncConfiguration.html @@ -490,7 +490,7 @@

Parameters

-

A RLMSyncUser that owns the Realm at the given URL.

+

A RLMSyncUser that owns the Realm at the given URL.

diff --git a/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMSyncPermissionChange.html b/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMSyncPermissionChange.html index 1bc226383..d964e5cac 100644 --- a/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMSyncPermissionChange.html +++ b/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMSyncPermissionChange.html @@ -769,7 +769,7 @@

Parameters

The Realm URL whose permissions settings should be changed. - Use * to change the permissions of all Realms managed by the Management Realm’s RLMSyncUser.

+ Use * to change the permissions of all Realms managed by the Management Realm’s RLMSyncUser.

diff --git a/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMSyncPermissionOfferResponse.html b/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMSyncPermissionOfferResponse.html index 85aa026a2..e10b3a0f9 100644 --- a/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMSyncPermissionOfferResponse.html +++ b/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMSyncPermissionOfferResponse.html @@ -664,7 +664,7 @@

Parameters

The received token which uniquely identifies another user’s - RLMSyncPermissionOffer.

+ RLMSyncPermissionOffer.

diff --git a/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMSyncPermissionValue.html b/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMSyncPermissionValue.html index 10fc7295b..11bd32085 100644 --- a/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMSyncPermissionValue.html +++ b/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Classes/RLMSyncPermissionValue.html @@ -568,7 +568,7 @@

Parameters

-

The identity of the user who should be granted access to the Realm at path. +

The identity of the user who should be granted access to the Realm at path. Pass * to apply to all users managed by the server.

diff --git a/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Protocols/RLMCollection.html b/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Protocols/RLMCollection.html index 8b5ba02c4..fe5eb0325 100644 --- a/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Protocols/RLMCollection.html +++ b/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Protocols/RLMCollection.html @@ -652,7 +652,7 @@

Parameters

-

An object (of the same type as returned from the objectClassName selector).

+

An object (of the same type as returned from the objectClassName selector).

@@ -1071,7 +1071,7 @@

Parameters

-

An array of RLMSortDescriptors to sort by.

+

An array of RLMSortDescriptors to sort by.

diff --git a/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Type Definitions.html b/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Type Definitions.html index 2d79c57de..09de8a792 100644 --- a/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Type Definitions.html +++ b/document_realm_objc/after/docs/docsets/Realm.docset/Contents/Resources/Documents/Type Definitions.html @@ -620,7 +620,7 @@

Parameters

-

A RLMMigration object used to perform the migration. The +

A RLMMigration object used to perform the migration. The migration object allows you to enumerate and alter any existing objects which require migration.

diff --git a/document_realm_swift/after/docs/Classes/AnyRealmCollection.html b/document_realm_swift/after/docs/Classes/AnyRealmCollection.html index 47c96b543..0dce863a9 100644 --- a/document_realm_swift/after/docs/Classes/AnyRealmCollection.html +++ b/document_realm_swift/after/docs/Classes/AnyRealmCollection.html @@ -310,25 +310,6 @@

Declaration

-
-

Parameters

- - - - - - - -
- - i - - -
- -
-
-
@@ -358,25 +339,6 @@

Declaration

-
-

Parameters

- - - - - - - -
- - i - - -
- -
-
-
@@ -1048,7 +1010,7 @@

Parameters

-

A sequence of SortDescriptors to sort by.

+

A sequence of SortDescriptors to sort by.

diff --git a/document_realm_swift/after/docs/Classes/LinkingObjects.html b/document_realm_swift/after/docs/Classes/LinkingObjects.html index e1123d00f..6d90cacc3 100644 --- a/document_realm_swift/after/docs/Classes/LinkingObjects.html +++ b/document_realm_swift/after/docs/Classes/LinkingObjects.html @@ -1297,7 +1297,7 @@

Parameters

-

A sequence of SortDescriptors to sort by.

+

A sequence of SortDescriptors to sort by.

@@ -1792,25 +1792,6 @@

Declaration

-
-

Parameters

- - - - - - - -
- - i - - -
- -
-
-
@@ -1840,25 +1821,6 @@

Declaration

-
-

Parameters

- - - - - - - -
- - i - - -
- -
-
-
diff --git a/document_realm_swift/after/docs/Classes/List.html b/document_realm_swift/after/docs/Classes/List.html index f317f4b21..8945a5735 100644 --- a/document_realm_swift/after/docs/Classes/List.html +++ b/document_realm_swift/after/docs/Classes/List.html @@ -2239,25 +2239,6 @@

Declaration

-
-

Parameters

- - - - - - - -
- - i - - -
- -
-
-
@@ -2287,25 +2268,6 @@

Declaration

-
-

Parameters

- - - - - - - -
- - i - - -
- -
-
-
diff --git a/document_realm_swift/after/docs/Classes/Migration.html b/document_realm_swift/after/docs/Classes/Migration.html index caff35c41..4c1c5fad7 100644 --- a/document_realm_swift/after/docs/Classes/Migration.html +++ b/document_realm_swift/after/docs/Classes/Migration.html @@ -404,7 +404,7 @@

Parameters

-

The name of the Object class to enumerate.

+

The name of the Object class to enumerate.

@@ -473,7 +473,7 @@

Parameters

-

The name of the Object class to create.

+

The name of the Object class to create.

@@ -592,7 +592,7 @@

Parameters

-

The name of the Object class to delete.

+

The name of the Object class to delete.

diff --git a/document_realm_swift/after/docs/Classes/Realm.html b/document_realm_swift/after/docs/Classes/Realm.html index 06528c930..89332cbb5 100644 --- a/document_realm_swift/after/docs/Classes/Realm.html +++ b/document_realm_swift/after/docs/Classes/Realm.html @@ -1307,9 +1307,9 @@

Parameters

-

The objects to be deleted. This can be a List<Object>, - Results<Object>, or any other Swift Sequence whose - elements are Objects (subject to the caveats above).

+

The objects to be deleted. This can be a List<Object>, + Results<Object>, or any other Swift Sequence whose + elements are Objects (subject to the caveats above).

diff --git a/document_realm_swift/after/docs/Classes/Realm/Configuration.html b/document_realm_swift/after/docs/Classes/Realm/Configuration.html index 97997ee21..77fd3e390 100644 --- a/document_realm_swift/after/docs/Classes/Realm/Configuration.html +++ b/document_realm_swift/after/docs/Classes/Realm/Configuration.html @@ -507,7 +507,7 @@

Parameters

-

The subset of Object subclasses persisted in the Realm.

+

The subset of Object subclasses persisted in the Realm.

diff --git a/document_realm_swift/after/docs/Classes/Results.html b/document_realm_swift/after/docs/Classes/Results.html index c5e6a1966..b4c884f0a 100644 --- a/document_realm_swift/after/docs/Classes/Results.html +++ b/document_realm_swift/after/docs/Classes/Results.html @@ -1221,7 +1221,7 @@

Parameters

-

A sequence of SortDescriptors to sort by.

+

A sequence of SortDescriptors to sort by.

@@ -1713,25 +1713,6 @@

Declaration

-
-

Parameters

- - - - - - - -
- - i - - -
- -
-
-
@@ -1761,25 +1742,6 @@

Declaration

-
-

Parameters

- - - - - - - -
- - i - - -
- -
-
-
diff --git a/document_realm_swift/after/docs/Classes/SyncPermissionChange.html b/document_realm_swift/after/docs/Classes/SyncPermissionChange.html index 549edc01b..f83880028 100644 --- a/document_realm_swift/after/docs/Classes/SyncPermissionChange.html +++ b/document_realm_swift/after/docs/Classes/SyncPermissionChange.html @@ -660,7 +660,7 @@

Parameters

The Realm URL whose permissions settings should be changed. - Use * to change the permissions of all Realms managed by the Management Realm’s SyncUser.

+ Use * to change the permissions of all Realms managed by the Management Realm’s SyncUser.

diff --git a/document_realm_swift/after/docs/Classes/SyncPermissionOfferResponse.html b/document_realm_swift/after/docs/Classes/SyncPermissionOfferResponse.html index 991f38f62..c4321b202 100644 --- a/document_realm_swift/after/docs/Classes/SyncPermissionOfferResponse.html +++ b/document_realm_swift/after/docs/Classes/SyncPermissionOfferResponse.html @@ -571,7 +571,7 @@

Parameters

The received token which uniquely identifies another user’s - SyncPermissionOffer.

+ SyncPermissionOffer.

diff --git a/document_realm_swift/after/docs/Extensions/SyncPermissionResults.html b/document_realm_swift/after/docs/Extensions/SyncPermissionResults.html index cd2e77ed7..242f7b15c 100644 --- a/document_realm_swift/after/docs/Extensions/SyncPermissionResults.html +++ b/document_realm_swift/after/docs/Extensions/SyncPermissionResults.html @@ -307,25 +307,6 @@

Declaration

-
-

Parameters

- - - - - - - -
- - i - - -
- -
-
-
diff --git a/document_realm_swift/after/docs/Protocols/RealmCollection.html b/document_realm_swift/after/docs/Protocols/RealmCollection.html index ee3a1b565..dfe6015fa 100644 --- a/document_realm_swift/after/docs/Protocols/RealmCollection.html +++ b/document_realm_swift/after/docs/Protocols/RealmCollection.html @@ -915,7 +915,7 @@

Parameters

-

A sequence of SortDescriptors to sort by.

+

A sequence of SortDescriptors to sort by.

@@ -1090,7 +1090,7 @@

Parameters

-

The name of a property conforming to AddableType to calculate sum on.

+

The name of a property conforming to AddableType to calculate sum on.

diff --git a/document_realm_swift/after/docs/Typealiases.html b/document_realm_swift/after/docs/Typealiases.html index 02c86d273..20b9c7a44 100644 --- a/document_realm_swift/after/docs/Typealiases.html +++ b/document_realm_swift/after/docs/Typealiases.html @@ -413,7 +413,7 @@

Parameters

-

A Migration object used to perform the migration. The migration object allows you to +

A Migration object used to perform the migration. The migration object allows you to enumerate and alter any existing objects which require migration.

diff --git a/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/AnyRealmCollection.html b/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/AnyRealmCollection.html index 47c96b543..0dce863a9 100644 --- a/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/AnyRealmCollection.html +++ b/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/AnyRealmCollection.html @@ -310,25 +310,6 @@

Declaration

-
-

Parameters

- - - - - - - -
- - i - - -
- -
-
-
@@ -358,25 +339,6 @@

Declaration

-
-

Parameters

- - - - - - - -
- - i - - -
- -
-
-
@@ -1048,7 +1010,7 @@

Parameters

-

A sequence of SortDescriptors to sort by.

+

A sequence of SortDescriptors to sort by.

diff --git a/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/LinkingObjects.html b/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/LinkingObjects.html index e1123d00f..6d90cacc3 100644 --- a/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/LinkingObjects.html +++ b/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/LinkingObjects.html @@ -1297,7 +1297,7 @@

Parameters

-

A sequence of SortDescriptors to sort by.

+

A sequence of SortDescriptors to sort by.

@@ -1792,25 +1792,6 @@

Declaration

-
-

Parameters

- - - - - - - -
- - i - - -
- -
-
-
@@ -1840,25 +1821,6 @@

Declaration

-
-

Parameters

- - - - - - - -
- - i - - -
- -
-
-
diff --git a/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/List.html b/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/List.html index f317f4b21..8945a5735 100644 --- a/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/List.html +++ b/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/List.html @@ -2239,25 +2239,6 @@

Declaration

-
-

Parameters

- - - - - - - -
- - i - - -
- -
-
-
@@ -2287,25 +2268,6 @@

Declaration

-
-

Parameters

- - - - - - - -
- - i - - -
- -
-
-
diff --git a/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/Migration.html b/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/Migration.html index caff35c41..4c1c5fad7 100644 --- a/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/Migration.html +++ b/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/Migration.html @@ -404,7 +404,7 @@

Parameters

-

The name of the Object class to enumerate.

+

The name of the Object class to enumerate.

@@ -473,7 +473,7 @@

Parameters

-

The name of the Object class to create.

+

The name of the Object class to create.

@@ -592,7 +592,7 @@

Parameters

-

The name of the Object class to delete.

+

The name of the Object class to delete.

diff --git a/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/Realm.html b/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/Realm.html index 06528c930..89332cbb5 100644 --- a/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/Realm.html +++ b/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/Realm.html @@ -1307,9 +1307,9 @@

Parameters

-

The objects to be deleted. This can be a List<Object>, - Results<Object>, or any other Swift Sequence whose - elements are Objects (subject to the caveats above).

+

The objects to be deleted. This can be a List<Object>, + Results<Object>, or any other Swift Sequence whose + elements are Objects (subject to the caveats above).

diff --git a/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/Realm/Configuration.html b/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/Realm/Configuration.html index 97997ee21..77fd3e390 100644 --- a/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/Realm/Configuration.html +++ b/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/Realm/Configuration.html @@ -507,7 +507,7 @@

Parameters

-

The subset of Object subclasses persisted in the Realm.

+

The subset of Object subclasses persisted in the Realm.

diff --git a/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/Results.html b/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/Results.html index c5e6a1966..b4c884f0a 100644 --- a/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/Results.html +++ b/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/Results.html @@ -1221,7 +1221,7 @@

Parameters

-

A sequence of SortDescriptors to sort by.

+

A sequence of SortDescriptors to sort by.

@@ -1713,25 +1713,6 @@

Declaration

-
-

Parameters

- - - - - - - -
- - i - - -
- -
-
-
@@ -1761,25 +1742,6 @@

Declaration

-
-

Parameters

- - - - - - - -
- - i - - -
- -
-
-
diff --git a/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/SyncPermissionChange.html b/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/SyncPermissionChange.html index 549edc01b..f83880028 100644 --- a/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/SyncPermissionChange.html +++ b/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/SyncPermissionChange.html @@ -660,7 +660,7 @@

Parameters

The Realm URL whose permissions settings should be changed. - Use * to change the permissions of all Realms managed by the Management Realm’s SyncUser.

+ Use * to change the permissions of all Realms managed by the Management Realm’s SyncUser.

diff --git a/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/SyncPermissionOfferResponse.html b/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/SyncPermissionOfferResponse.html index 991f38f62..c4321b202 100644 --- a/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/SyncPermissionOfferResponse.html +++ b/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Classes/SyncPermissionOfferResponse.html @@ -571,7 +571,7 @@

Parameters

The received token which uniquely identifies another user’s - SyncPermissionOffer.

+ SyncPermissionOffer.

diff --git a/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Extensions/SyncPermissionResults.html b/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Extensions/SyncPermissionResults.html index cd2e77ed7..242f7b15c 100644 --- a/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Extensions/SyncPermissionResults.html +++ b/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Extensions/SyncPermissionResults.html @@ -307,25 +307,6 @@

Declaration

-
-

Parameters

- - - - - - - -
- - i - - -
- -
-
-
diff --git a/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Protocols/RealmCollection.html b/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Protocols/RealmCollection.html index ee3a1b565..dfe6015fa 100644 --- a/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Protocols/RealmCollection.html +++ b/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Protocols/RealmCollection.html @@ -915,7 +915,7 @@

Parameters

-

A sequence of SortDescriptors to sort by.

+

A sequence of SortDescriptors to sort by.

@@ -1090,7 +1090,7 @@

Parameters

-

The name of a property conforming to AddableType to calculate sum on.

+

The name of a property conforming to AddableType to calculate sum on.

diff --git a/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Typealiases.html b/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Typealiases.html index 02c86d273..20b9c7a44 100644 --- a/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Typealiases.html +++ b/document_realm_swift/after/docs/docsets/RealmSwift.docset/Contents/Resources/Documents/Typealiases.html @@ -413,7 +413,7 @@

Parameters

-

A Migration object used to perform the migration. The migration object allows you to +

A Migration object used to perform the migration. The migration object allows you to enumerate and alter any existing objects which require migration.

diff --git a/document_siesta/after/api-docs/Classes/Service.html b/document_siesta/after/api-docs/Classes/Service.html index 7c9521a69..016bf3cbe 100644 --- a/document_siesta/after/api-docs/Classes/Service.html +++ b/document_siesta/after/api-docs/Classes/Service.html @@ -334,7 +334,7 @@

Parameters

The URL underneath which the API exposes its endpoints. If nil, there is no base URL, and thus you must use -only resource(absoluteURL:) and resource(baseURL:path:) to acquire resources.

+only resource(absoluteURL:) and resource(baseURL:path:) to acquire resources.

@@ -347,7 +347,7 @@

Parameters

If true, include handling for JSON, text, and images. If false, leave all responses as Data (unless you -add your own ResponseTransformer using configure(...)).

+add your own ResponseTransformer using configure(...)).

@@ -361,7 +361,7 @@

Parameters

The handler to use for networking. The default is URLSession with ephemeral session configuration. You can pass an URLSession, URLSessionConfiguration, or Alamofire.Manager to use an existing provider with -custom configuration. You can also use your own networking library of choice by implementing NetworkingProvider.

+custom configuration. You can also use your own networking library of choice by implementing NetworkingProvider.

@@ -580,9 +580,9 @@

Parameters

-

Selects the subset of resources to which this configuration applies. You can pass a String, Resource, or +

Selects the subset of resources to which this configuration applies. You can pass a String, Resource, or NSRegularExpression for the pattern argument — or write your own custom implementation of -ConfigurationPatternConvertible.

+ConfigurationPatternConvertible.

@@ -606,7 +606,7 @@

Parameters

-

A closure that receives a mutable Configuration, referenced as $0, which it may modify as it +

A closure that receives a mutable Configuration, referenced as $0, which it may modify as it sees fit. This closure will be called whenever Siesta needs to generate or refresh configuration. You should not rely on it being called at any particular time, and should avoid making it cause side effects.

diff --git a/document_siesta/after/api-docs/Structs/ResponseContentTransformer.html b/document_siesta/after/api-docs/Structs/ResponseContentTransformer.html index 607b34289..842faecac 100644 --- a/document_siesta/after/api-docs/Structs/ResponseContentTransformer.html +++ b/document_siesta/after/api-docs/Structs/ResponseContentTransformer.html @@ -331,7 +331,7 @@

Parameters

Determines what happens when the actual content coming down the pipeline doesn’t match InputContentType. -See InputTypeMismatchAction for options. The default is .error.

+See InputTypeMismatchAction for options. The default is .error.

diff --git a/document_siesta/after/api-docs/docsets/Siesta.docset/Contents/Resources/Documents/Classes/Service.html b/document_siesta/after/api-docs/docsets/Siesta.docset/Contents/Resources/Documents/Classes/Service.html index 7c9521a69..016bf3cbe 100644 --- a/document_siesta/after/api-docs/docsets/Siesta.docset/Contents/Resources/Documents/Classes/Service.html +++ b/document_siesta/after/api-docs/docsets/Siesta.docset/Contents/Resources/Documents/Classes/Service.html @@ -334,7 +334,7 @@

Parameters

The URL underneath which the API exposes its endpoints. If nil, there is no base URL, and thus you must use -only resource(absoluteURL:) and resource(baseURL:path:) to acquire resources.

+only resource(absoluteURL:) and resource(baseURL:path:) to acquire resources.

@@ -347,7 +347,7 @@

Parameters

If true, include handling for JSON, text, and images. If false, leave all responses as Data (unless you -add your own ResponseTransformer using configure(...)).

+add your own ResponseTransformer using configure(...)).

@@ -361,7 +361,7 @@

Parameters

The handler to use for networking. The default is URLSession with ephemeral session configuration. You can pass an URLSession, URLSessionConfiguration, or Alamofire.Manager to use an existing provider with -custom configuration. You can also use your own networking library of choice by implementing NetworkingProvider.

+custom configuration. You can also use your own networking library of choice by implementing NetworkingProvider.

@@ -580,9 +580,9 @@

Parameters

-

Selects the subset of resources to which this configuration applies. You can pass a String, Resource, or +

Selects the subset of resources to which this configuration applies. You can pass a String, Resource, or NSRegularExpression for the pattern argument — or write your own custom implementation of -ConfigurationPatternConvertible.

+ConfigurationPatternConvertible.

@@ -606,7 +606,7 @@

Parameters

-

A closure that receives a mutable Configuration, referenced as $0, which it may modify as it +

A closure that receives a mutable Configuration, referenced as $0, which it may modify as it sees fit. This closure will be called whenever Siesta needs to generate or refresh configuration. You should not rely on it being called at any particular time, and should avoid making it cause side effects.

diff --git a/document_siesta/after/api-docs/docsets/Siesta.docset/Contents/Resources/Documents/Structs/ResponseContentTransformer.html b/document_siesta/after/api-docs/docsets/Siesta.docset/Contents/Resources/Documents/Structs/ResponseContentTransformer.html index 607b34289..842faecac 100644 --- a/document_siesta/after/api-docs/docsets/Siesta.docset/Contents/Resources/Documents/Structs/ResponseContentTransformer.html +++ b/document_siesta/after/api-docs/docsets/Siesta.docset/Contents/Resources/Documents/Structs/ResponseContentTransformer.html @@ -331,7 +331,7 @@

Parameters

Determines what happens when the actual content coming down the pipeline doesn’t match InputContentType. -See InputTypeMismatchAction for options. The default is .error.

+See InputTypeMismatchAction for options. The default is .error.

diff --git a/misc_jazzy_features/after/docs/Classes/ClassWithInitializers.html b/misc_jazzy_features/after/docs/Classes/ClassWithInitializers.html index 8de42cf8b..77dfdee8c 100644 --- a/misc_jazzy_features/after/docs/Classes/ClassWithInitializers.html +++ b/misc_jazzy_features/after/docs/Classes/ClassWithInitializers.html @@ -107,6 +107,9 @@ + @@ -174,6 +177,14 @@ +
@@ -188,6 +199,8 @@

ClassWithInitializers

Example extra abstract to inject before default abstract of ClassWithInitializers

+ +

Autolink to DocumentedEnum.documentedValue.

Class with initializers

diff --git a/misc_jazzy_features/after/docs/Classes/ImplicitlyInternalTopLevelClass.html b/misc_jazzy_features/after/docs/Classes/ImplicitlyInternalTopLevelClass.html index c283339bc..d0e0bd9ef 100644 --- a/misc_jazzy_features/after/docs/Classes/ImplicitlyInternalTopLevelClass.html +++ b/misc_jazzy_features/after/docs/Classes/ImplicitlyInternalTopLevelClass.html @@ -107,6 +107,9 @@ + @@ -174,6 +177,14 @@ +
diff --git a/misc_jazzy_features/after/docs/Classes/ImplicitlyInternalTopLevelClass/NestedClass.html b/misc_jazzy_features/after/docs/Classes/ImplicitlyInternalTopLevelClass/NestedClass.html index bb018f586..0256b0c51 100644 --- a/misc_jazzy_features/after/docs/Classes/ImplicitlyInternalTopLevelClass/NestedClass.html +++ b/misc_jazzy_features/after/docs/Classes/ImplicitlyInternalTopLevelClass/NestedClass.html @@ -107,6 +107,9 @@ + @@ -174,6 +177,14 @@ +
diff --git a/misc_jazzy_features/after/docs/Classes/MiscMarkdown.html b/misc_jazzy_features/after/docs/Classes/MiscMarkdown.html index 4ffa0b920..f09a6e449 100644 --- a/misc_jazzy_features/after/docs/Classes/MiscMarkdown.html +++ b/misc_jazzy_features/after/docs/Classes/MiscMarkdown.html @@ -107,6 +107,9 @@ + @@ -174,6 +177,14 @@ +
diff --git a/misc_jazzy_features/after/docs/Classes/Operators.html b/misc_jazzy_features/after/docs/Classes/Operators.html new file mode 100644 index 000000000..9b4342ab3 --- /dev/null +++ b/misc_jazzy_features/after/docs/Classes/Operators.html @@ -0,0 +1,244 @@ + + + + Operators Class Reference + + + + + + + + + + + + + + + + +
+

+ + MiscJazzyFeatures Docs + + +

+ +

+

+ +
+

+ +

+ + + View on GitHub + +

+ +
+ + + +
+ +
+ +
+
+

Operators

+

Undocumented

+ +
+
+ +
+
+
+
    +
  • +
    + + + + <(_:_:) + +
    +
    +
    +
    +
    +
    +

    Function with characters unsafe for html.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func <(lhs: DocumentedEnum, rhs: DocumentedEnum) : Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + + + diff --git a/misc_jazzy_features/after/docs/Classes/TopLevelClass.html b/misc_jazzy_features/after/docs/Classes/TopLevelClass.html index 4e82aeca3..b134668d7 100644 --- a/misc_jazzy_features/after/docs/Classes/TopLevelClass.html +++ b/misc_jazzy_features/after/docs/Classes/TopLevelClass.html @@ -107,6 +107,9 @@ + @@ -174,6 +177,14 @@ +
diff --git a/misc_jazzy_features/after/docs/Classes/TopLevelClass/NestedLevel1.html b/misc_jazzy_features/after/docs/Classes/TopLevelClass/NestedLevel1.html index 9b9cf686c..172861cbc 100644 --- a/misc_jazzy_features/after/docs/Classes/TopLevelClass/NestedLevel1.html +++ b/misc_jazzy_features/after/docs/Classes/TopLevelClass/NestedLevel1.html @@ -107,6 +107,9 @@ + @@ -174,6 +177,14 @@ +
diff --git a/misc_jazzy_features/after/docs/Classes/TopLevelClass/NestedLevel1/NestedLevel2.html b/misc_jazzy_features/after/docs/Classes/TopLevelClass/NestedLevel1/NestedLevel2.html index 4e1b36884..4483dd0f9 100644 --- a/misc_jazzy_features/after/docs/Classes/TopLevelClass/NestedLevel1/NestedLevel2.html +++ b/misc_jazzy_features/after/docs/Classes/TopLevelClass/NestedLevel1/NestedLevel2.html @@ -107,6 +107,9 @@ + @@ -174,6 +177,14 @@ +
diff --git a/misc_jazzy_features/after/docs/Enums/DocumentedEnum.html b/misc_jazzy_features/after/docs/Enums/DocumentedEnum.html index 55b18ebdc..fd0fe209e 100644 --- a/misc_jazzy_features/after/docs/Enums/DocumentedEnum.html +++ b/misc_jazzy_features/after/docs/Enums/DocumentedEnum.html @@ -107,6 +107,9 @@ + @@ -174,6 +177,14 @@ +
diff --git a/misc_jazzy_features/after/docs/Enums/UndocumentedEnum.html b/misc_jazzy_features/after/docs/Enums/UndocumentedEnum.html index b5f19026d..f166c3bbe 100644 --- a/misc_jazzy_features/after/docs/Enums/UndocumentedEnum.html +++ b/misc_jazzy_features/after/docs/Enums/UndocumentedEnum.html @@ -107,6 +107,9 @@ + @@ -174,6 +177,14 @@ +
diff --git a/misc_jazzy_features/after/docs/Extensions/NSObject.html b/misc_jazzy_features/after/docs/Extensions/NSObject.html index 8d5d065e3..c456c5845 100644 --- a/misc_jazzy_features/after/docs/Extensions/NSObject.html +++ b/misc_jazzy_features/after/docs/Extensions/NSObject.html @@ -107,6 +107,9 @@ + @@ -174,6 +177,14 @@ +
diff --git a/misc_jazzy_features/after/docs/Extensions/String.html b/misc_jazzy_features/after/docs/Extensions/String.html index 400575e61..5f8dd8d56 100644 --- a/misc_jazzy_features/after/docs/Extensions/String.html +++ b/misc_jazzy_features/after/docs/Extensions/String.html @@ -107,6 +107,9 @@ + @@ -174,6 +177,14 @@ +
diff --git a/misc_jazzy_features/after/docs/Extensions/String/CharacterView.html b/misc_jazzy_features/after/docs/Extensions/String/CharacterView.html index 3685243ec..b36b745fc 100644 --- a/misc_jazzy_features/after/docs/Extensions/String/CharacterView.html +++ b/misc_jazzy_features/after/docs/Extensions/String/CharacterView.html @@ -107,6 +107,9 @@ + @@ -174,6 +177,14 @@ +
diff --git a/misc_jazzy_features/after/docs/Functions/_2F_28_5F_3A_5F_3A_29.html b/misc_jazzy_features/after/docs/Functions/_2F_28_5F_3A_5F_3A_29.html index 4fed4a92e..a994bc61c 100644 --- a/misc_jazzy_features/after/docs/Functions/_2F_28_5F_3A_5F_3A_29.html +++ b/misc_jazzy_features/after/docs/Functions/_2F_28_5F_3A_5F_3A_29.html @@ -107,6 +107,9 @@ + @@ -174,6 +177,14 @@ +
diff --git a/misc_jazzy_features/after/docs/Guides.html b/misc_jazzy_features/after/docs/Guides.html index 8d0dd8eff..9665825f8 100644 --- a/misc_jazzy_features/after/docs/Guides.html +++ b/misc_jazzy_features/after/docs/Guides.html @@ -106,6 +106,9 @@ + @@ -173,6 +176,14 @@ +
@@ -184,6 +195,8 @@

Guides

Example abstract for the Guides section

+

Autolink to DocumentedEnum.documentedValue.

+ diff --git a/misc_jazzy_features/after/docs/Other Classes.html b/misc_jazzy_features/after/docs/Other Classes.html index 423f9a682..2903bf49b 100644 --- a/misc_jazzy_features/after/docs/Other Classes.html +++ b/misc_jazzy_features/after/docs/Other Classes.html @@ -106,6 +106,9 @@ + @@ -173,6 +176,14 @@ +
@@ -425,6 +436,30 @@

Declaration

+
+ +
diff --git a/misc_jazzy_features/after/docs/Other Enums.html b/misc_jazzy_features/after/docs/Other Enums.html index 0f1a6ed9e..44ea9659c 100644 --- a/misc_jazzy_features/after/docs/Other Enums.html +++ b/misc_jazzy_features/after/docs/Other Enums.html @@ -106,6 +106,9 @@ + @@ -173,6 +176,14 @@ +
diff --git a/misc_jazzy_features/after/docs/Other Extensions.html b/misc_jazzy_features/after/docs/Other Extensions.html index 49599fd0b..bb6dff28b 100644 --- a/misc_jazzy_features/after/docs/Other Extensions.html +++ b/misc_jazzy_features/after/docs/Other Extensions.html @@ -106,6 +106,9 @@ + @@ -173,6 +176,14 @@ +
diff --git a/misc_jazzy_features/after/docs/Other Functions.html b/misc_jazzy_features/after/docs/Other Functions.html index ca7cf4fa8..1e327b90a 100644 --- a/misc_jazzy_features/after/docs/Other Functions.html +++ b/misc_jazzy_features/after/docs/Other Functions.html @@ -106,6 +106,9 @@ + @@ -173,6 +176,14 @@ +
@@ -229,6 +240,8 @@

Parameters

Use this parameter like so:

aParameter
 
+ +

Also see functionB(_:) and DocumentedEnum.documentedValue

diff --git a/misc_jazzy_features/after/docs/Other Global Variables.html b/misc_jazzy_features/after/docs/Other Global Variables.html index 448d29ee0..dd30156b7 100644 --- a/misc_jazzy_features/after/docs/Other Global Variables.html +++ b/misc_jazzy_features/after/docs/Other Global Variables.html @@ -106,6 +106,9 @@ + @@ -173,6 +176,14 @@ +
diff --git a/misc_jazzy_features/after/docs/Other Structs.html b/misc_jazzy_features/after/docs/Other Structs.html new file mode 100644 index 000000000..9a11a30eb --- /dev/null +++ b/misc_jazzy_features/after/docs/Other Structs.html @@ -0,0 +1,251 @@ + + + + Other Structs Reference + + + + + + + + + + + + + + + +
+

+ + MiscJazzyFeatures Docs + + +

+ +

+

+ +
+

+ +

+ + + View on GitHub + +

+ +
+ + + +
+ +
+ +
+
+

Other Structs

+

The following structs are available globally.

+ +
+
+ +
+
+
+ +
    +
  • +
    + + + + GenericStruct + +
    +
    +
    +
    +
    +
    +

    A generic structure.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    struct GenericStruct<T>
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + + + diff --git a/misc_jazzy_features/after/docs/Structs/GenericStruct.html b/misc_jazzy_features/after/docs/Structs/GenericStruct.html new file mode 100644 index 000000000..ff4ddc90e --- /dev/null +++ b/misc_jazzy_features/after/docs/Structs/GenericStruct.html @@ -0,0 +1,250 @@ + + + + GenericStruct Struct Reference + + + + + + + + + + + + + + + + +
+

+ + MiscJazzyFeatures Docs + + +

+ +

+

+ +
+

+ +

+ + + View on GitHub + +

+ +
+ + + +
+ +
+ +
+
+

GenericStruct

+
+
+
struct GenericStruct<T>
+ +
+
+

A generic structure.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + t + +
    +
    +
    +
    +
    +
    +

    Undocumented

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    struct GenericStruct<T>
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + + + diff --git a/misc_jazzy_features/after/docs/Yang.html b/misc_jazzy_features/after/docs/Yang.html index b4f8e86e2..6001bc3cc 100644 --- a/misc_jazzy_features/after/docs/Yang.html +++ b/misc_jazzy_features/after/docs/Yang.html @@ -106,6 +106,9 @@ + @@ -173,6 +176,14 @@ +
diff --git a/misc_jazzy_features/after/docs/Yin.html b/misc_jazzy_features/after/docs/Yin.html index 687fdd0d3..cb2711e4f 100644 --- a/misc_jazzy_features/after/docs/Yin.html +++ b/misc_jazzy_features/after/docs/Yin.html @@ -106,6 +106,9 @@ + @@ -173,6 +176,14 @@ +
diff --git a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/ClassWithInitializers.html b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/ClassWithInitializers.html index 8de42cf8b..77dfdee8c 100644 --- a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/ClassWithInitializers.html +++ b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/ClassWithInitializers.html @@ -107,6 +107,9 @@ + @@ -174,6 +177,14 @@ +
@@ -188,6 +199,8 @@

ClassWithInitializers

Example extra abstract to inject before default abstract of ClassWithInitializers

+ +

Autolink to DocumentedEnum.documentedValue.

Class with initializers

diff --git a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/ImplicitlyInternalTopLevelClass.html b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/ImplicitlyInternalTopLevelClass.html index c283339bc..d0e0bd9ef 100644 --- a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/ImplicitlyInternalTopLevelClass.html +++ b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/ImplicitlyInternalTopLevelClass.html @@ -107,6 +107,9 @@ + @@ -174,6 +177,14 @@ +
diff --git a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/ImplicitlyInternalTopLevelClass/NestedClass.html b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/ImplicitlyInternalTopLevelClass/NestedClass.html index bb018f586..0256b0c51 100644 --- a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/ImplicitlyInternalTopLevelClass/NestedClass.html +++ b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/ImplicitlyInternalTopLevelClass/NestedClass.html @@ -107,6 +107,9 @@ + @@ -174,6 +177,14 @@ +
diff --git a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/MiscMarkdown.html b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/MiscMarkdown.html index 4ffa0b920..f09a6e449 100644 --- a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/MiscMarkdown.html +++ b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/MiscMarkdown.html @@ -107,6 +107,9 @@ + @@ -174,6 +177,14 @@ +
diff --git a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/Operators.html b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/Operators.html new file mode 100644 index 000000000..9b4342ab3 --- /dev/null +++ b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/Operators.html @@ -0,0 +1,244 @@ + + + + Operators Class Reference + + + + + + + + + + + + + + + + +
+

+ + MiscJazzyFeatures Docs + + +

+ +

+

+ +
+

+ +

+ + + View on GitHub + +

+ +
+ + + +
+ +
+ +
+
+

Operators

+

Undocumented

+ +
+
+ +
+
+
+
    +
  • +
    + + + + <(_:_:) + +
    +
    +
    +
    +
    +
    +

    Function with characters unsafe for html.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public static func <(lhs: DocumentedEnum, rhs: DocumentedEnum) : Bool
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + + + diff --git a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/TopLevelClass.html b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/TopLevelClass.html index 4e82aeca3..b134668d7 100644 --- a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/TopLevelClass.html +++ b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/TopLevelClass.html @@ -107,6 +107,9 @@ + @@ -174,6 +177,14 @@ +
diff --git a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/TopLevelClass/NestedLevel1.html b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/TopLevelClass/NestedLevel1.html index 9b9cf686c..172861cbc 100644 --- a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/TopLevelClass/NestedLevel1.html +++ b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/TopLevelClass/NestedLevel1.html @@ -107,6 +107,9 @@ + @@ -174,6 +177,14 @@ +
diff --git a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/TopLevelClass/NestedLevel1/NestedLevel2.html b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/TopLevelClass/NestedLevel1/NestedLevel2.html index 4e1b36884..4483dd0f9 100644 --- a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/TopLevelClass/NestedLevel1/NestedLevel2.html +++ b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Classes/TopLevelClass/NestedLevel1/NestedLevel2.html @@ -107,6 +107,9 @@ + @@ -174,6 +177,14 @@ +
diff --git a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Enums/DocumentedEnum.html b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Enums/DocumentedEnum.html index 55b18ebdc..fd0fe209e 100644 --- a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Enums/DocumentedEnum.html +++ b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Enums/DocumentedEnum.html @@ -107,6 +107,9 @@ + @@ -174,6 +177,14 @@ +
diff --git a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Enums/UndocumentedEnum.html b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Enums/UndocumentedEnum.html index b5f19026d..f166c3bbe 100644 --- a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Enums/UndocumentedEnum.html +++ b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Enums/UndocumentedEnum.html @@ -107,6 +107,9 @@ + @@ -174,6 +177,14 @@ +
diff --git a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Extensions/NSObject.html b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Extensions/NSObject.html index 8d5d065e3..c456c5845 100644 --- a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Extensions/NSObject.html +++ b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Extensions/NSObject.html @@ -107,6 +107,9 @@ + @@ -174,6 +177,14 @@ +
diff --git a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Extensions/String.html b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Extensions/String.html index 400575e61..5f8dd8d56 100644 --- a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Extensions/String.html +++ b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Extensions/String.html @@ -107,6 +107,9 @@ + @@ -174,6 +177,14 @@ +
diff --git a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Extensions/String/CharacterView.html b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Extensions/String/CharacterView.html index 3685243ec..b36b745fc 100644 --- a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Extensions/String/CharacterView.html +++ b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Extensions/String/CharacterView.html @@ -107,6 +107,9 @@ + @@ -174,6 +177,14 @@ +
diff --git a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Functions/_2F_28_5F_3A_5F_3A_29.html b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Functions/_2F_28_5F_3A_5F_3A_29.html index 4fed4a92e..a994bc61c 100644 --- a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Functions/_2F_28_5F_3A_5F_3A_29.html +++ b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Functions/_2F_28_5F_3A_5F_3A_29.html @@ -107,6 +107,9 @@ + @@ -174,6 +177,14 @@ +
diff --git a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Guides.html b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Guides.html index 8d0dd8eff..9665825f8 100644 --- a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Guides.html +++ b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Guides.html @@ -106,6 +106,9 @@ + @@ -173,6 +176,14 @@ +
@@ -184,6 +195,8 @@

Guides

Example abstract for the Guides section

+

Autolink to DocumentedEnum.documentedValue.

+ diff --git a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Other Classes.html b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Other Classes.html index 423f9a682..2903bf49b 100644 --- a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Other Classes.html +++ b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Other Classes.html @@ -106,6 +106,9 @@ + @@ -173,6 +176,14 @@ +
@@ -425,6 +436,30 @@

Declaration

+
+ +
diff --git a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Other Enums.html b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Other Enums.html index 0f1a6ed9e..44ea9659c 100644 --- a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Other Enums.html +++ b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Other Enums.html @@ -106,6 +106,9 @@ + @@ -173,6 +176,14 @@ +
diff --git a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Other Extensions.html b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Other Extensions.html index 49599fd0b..bb6dff28b 100644 --- a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Other Extensions.html +++ b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Other Extensions.html @@ -106,6 +106,9 @@ + @@ -173,6 +176,14 @@ +
diff --git a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Other Functions.html b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Other Functions.html index ca7cf4fa8..1e327b90a 100644 --- a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Other Functions.html +++ b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Other Functions.html @@ -106,6 +106,9 @@ + @@ -173,6 +176,14 @@ +
@@ -229,6 +240,8 @@

Parameters

Use this parameter like so:

aParameter
 
+ +

Also see functionB(_:) and DocumentedEnum.documentedValue

diff --git a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Other Global Variables.html b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Other Global Variables.html index 448d29ee0..dd30156b7 100644 --- a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Other Global Variables.html +++ b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Other Global Variables.html @@ -106,6 +106,9 @@ + @@ -173,6 +176,14 @@ +
diff --git a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Other Structs.html b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Other Structs.html new file mode 100644 index 000000000..9a11a30eb --- /dev/null +++ b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Other Structs.html @@ -0,0 +1,251 @@ + + + + Other Structs Reference + + + + + + + + + + + + + + + +
+

+ + MiscJazzyFeatures Docs + + +

+ +

+

+ +
+

+ +

+ + + View on GitHub + +

+ +
+ + + +
+ +
+ +
+
+

Other Structs

+

The following structs are available globally.

+ +
+
+ +
+
+
+ +
    +
  • +
    + + + + GenericStruct + +
    +
    +
    +
    +
    +
    +

    A generic structure.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    struct GenericStruct<T>
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + + + diff --git a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Structs/GenericStruct.html b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Structs/GenericStruct.html new file mode 100644 index 000000000..ff4ddc90e --- /dev/null +++ b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Structs/GenericStruct.html @@ -0,0 +1,250 @@ + + + + GenericStruct Struct Reference + + + + + + + + + + + + + + + + +
+

+ + MiscJazzyFeatures Docs + + +

+ +

+

+ +
+

+ +

+ + + View on GitHub + +

+ +
+ + + +
+ +
+ +
+
+

GenericStruct

+
+
+
struct GenericStruct<T>
+ +
+
+

A generic structure.

+ +
+
+ +
+
+
+
    +
  • +
    + + + + t + +
    +
    +
    +
    +
    +
    +

    Undocumented

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    struct GenericStruct<T>
    + +
    +
    +
    +
    +
  • +
+
+
+
+ +
+
+ + + + diff --git a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Yang.html b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Yang.html index b4f8e86e2..6001bc3cc 100644 --- a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Yang.html +++ b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Yang.html @@ -106,6 +106,9 @@ + @@ -173,6 +176,14 @@ +
diff --git a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Yin.html b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Yin.html index 687fdd0d3..cb2711e4f 100644 --- a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Yin.html +++ b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/Yin.html @@ -106,6 +106,9 @@ + @@ -173,6 +176,14 @@ +
diff --git a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/example-1.html b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/example-1.html index 81c76a01a..fe1791316 100644 --- a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/example-1.html +++ b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/example-1.html @@ -106,6 +106,9 @@ + @@ -173,6 +176,14 @@ +
@@ -182,6 +193,8 @@

Example Docs File 1

+

Autolink to DocumentedEnum.documentedValue.

+ diff --git a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/example-2.html b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/example-2.html index a2f7a6e67..4928b544b 100644 --- a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/example-2.html +++ b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/example-2.html @@ -106,6 +106,9 @@ + @@ -173,6 +176,14 @@ +
diff --git a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/index.html b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/index.html index f691c40bc..6dfeed28b 100644 --- a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/index.html +++ b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/index.html @@ -106,6 +106,9 @@ + @@ -173,6 +176,14 @@ +
@@ -183,9 +194,15 @@

Misc Jazzy Features

-

Sample fixtures for miscellanious Jazzy features

+

Sample fixtures for miscellaneous Jazzy features

+

Autolink to DocumentedEnum.documentedValue.

+ +

Autolink to Operators.<(...).

+ +

Autolink to GenericStruct<Anything> links to GenericStruct.

+ diff --git a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/search.json b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/search.json index a9d8d8029..d3626e4fd 100644 --- a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/search.json +++ b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/Documents/search.json @@ -1 +1 @@ -{"Functions/_2F_28_5F_3A_5F_3A_29.html#/s:tF17MiscJazzyFeaturesoi1durFTxx_T_L_1TMx":{"name":"T","parent_name":"/(_:_:)"},"Other Functions.html#/s:F17MiscJazzyFeatures9functionAFTSb10bParameterSb_Sb":{"name":"functionA(_:bParameter:)","abstract":"

Function (recommended documentation comment style)

"},"Other Functions.html#/s:F17MiscJazzyFeatures9functionBFSbSb":{"name":"functionB(_:)","abstract":"

Function (alternate documentation comment style)

"},"Other Functions.html#/s:F17MiscJazzyFeatures9functionCFSbSb":{"name":"functionC(_:)","abstract":"

Function (non‐standard documentation comment style)

"},"Other Functions.html#/s:F17MiscJazzyFeatures9functionDFSbSb":{"name":"functionD(_:)","abstract":"

Function (alternate non‐standard documentation comment style)

"},"Other Functions.html#/s:F17MiscJazzyFeatures9functionEFSbSb":{"name":"functionE(_:)","abstract":"

Function (alternate documentation comment style #2)

"},"Functions/_2F_28_5F_3A_5F_3A_29.html":{"name":"/(_:_:)","abstract":"

Function with characters unsafe for filenames.

"},"Extensions/String/CharacterView.html#/s:FE17MiscJazzyFeaturesVSS13CharacterView2eeFT_T_":{"name":"ee()","abstract":"

Method from an extension

","parent_name":"CharacterView"},"Extensions/String/CharacterView.html":{"name":"CharacterView","abstract":"

Extension of a nested external class

","parent_name":"String"},"Extensions/NSObject.html#/s:FE17MiscJazzyFeaturesCSo8NSObject2eeFT_T_":{"name":"ee()","abstract":"

Method from an extension

","parent_name":"NSObject"},"Extensions/NSObject.html":{"name":"NSObject","abstract":"

Extension of top-level external class

"},"Extensions/String.html":{"name":"String"},"Enums/DocumentedEnum.html#/s:FO17MiscJazzyFeatures14DocumentedEnum15documentedValueFMS0_S0_":{"name":"documentedValue","abstract":"

SUPPORTED: documented enum element

","parent_name":"DocumentedEnum"},"Enums/DocumentedEnum.html":{"name":"DocumentedEnum","abstract":"

SUPPORTED: documented enum

"},"Other Global Variables.html#/s:v17MiscJazzyFeatures18undocumentedGlobalSb":{"name":"undocumentedGlobal","abstract":"

Undocumented

"},"Classes/TopLevelClass/NestedLevel1/NestedLevel2.html#/s:FCCC17MiscJazzyFeatures13TopLevelClass12NestedLevel112NestedLevel23nn2FT_T_":{"name":"nn2()","abstract":"

Nested-2 method

","parent_name":"NestedLevel2"},"Classes/TopLevelClass/NestedLevel1/NestedLevel2.html#/s:FCCC17MiscJazzyFeatures13TopLevelClass12NestedLevel112NestedLevel22ffFT_T_":{"name":"ff()","abstract":"

Method from a doubly-nested extension

","parent_name":"NestedLevel2"},"Classes/TopLevelClass/NestedLevel1.html#/s:FCC17MiscJazzyFeatures13TopLevelClass12NestedLevel13nn1FT_T_":{"name":"nn1()","abstract":"

Nested method

","parent_name":"NestedLevel1"},"Classes/TopLevelClass/NestedLevel1/NestedLevel2.html":{"name":"NestedLevel2","abstract":"

Undocumented

","parent_name":"NestedLevel1"},"Classes/TopLevelClass.html#/s:FC17MiscJazzyFeatures13TopLevelClass2ttFT_T_":{"name":"tt()","abstract":"

Top level method

","parent_name":"TopLevelClass"},"Classes/TopLevelClass/NestedLevel1.html":{"name":"NestedLevel1","abstract":"

Undocumented

","parent_name":"TopLevelClass"},"Classes/ClassWithInitializers.html#/s:FC17MiscJazzyFeatures21ClassWithInitializerscFT_S0_":{"name":"init()","abstract":"

Empty init

","parent_name":"ClassWithInitializers"},"Classes/ClassWithInitializers.html#/s:FC17MiscJazzyFeatures21ClassWithInitializerscFT1aT__S0_":{"name":"init(a:)","abstract":"

Parameterized init

","parent_name":"ClassWithInitializers"},"Classes/ClassWithInitializers.html#/s:FC17MiscJazzyFeatures21ClassWithInitializerscFT1bT__S0_":{"name":"init(b:)","abstract":"

Undocumented

","parent_name":"ClassWithInitializers"},"Classes/ClassWithInitializers.html#/s:FC17MiscJazzyFeatures21ClassWithInitializers2eeFT_T_":{"name":"ee()","abstract":"

Method from an extension

","parent_name":"ClassWithInitializers"},"Classes/ImplicitlyInternalTopLevelClass/NestedClass.html#/s:FCC17MiscJazzyFeatures31ImplicitlyInternalTopLevelClass11NestedClass2eeFT_T_":{"name":"ee()","abstract":"

Method from an extension

","parent_name":"NestedClass"},"Classes/ImplicitlyInternalTopLevelClass/NestedClass.html":{"name":"NestedClass","abstract":"

SUPPORTED: Nested class

","parent_name":"ImplicitlyInternalTopLevelClass"},"Classes/MiscMarkdown.html#/s:FC17MiscJazzyFeatures12MiscMarkdown11linespacingFT_T_":{"name":"linespacing()","abstract":"

Blank line not required before:

","parent_name":"MiscMarkdown"},"Classes/MiscMarkdown.html":{"name":"MiscMarkdown","abstract":"

A class to demonstrate miscellaneous markdown formatting behaviors

"},"Classes/ImplicitlyInternalTopLevelClass.html":{"name":"ImplicitlyInternalTopLevelClass","abstract":"

SUPPORTED: implicitly internal top-level class

"},"Other Classes.html#/s:C17MiscJazzyFeatures31ExplicitlyInternalTopLevelClass":{"name":"ExplicitlyInternalTopLevelClass","abstract":"

SUPPORTED: explicitly internal top-level class

"},"Other Classes.html#/s:C17MiscJazzyFeatures17ObjCTopLevelClass":{"name":"ObjCTopLevelClass","abstract":"

SUPPORTED: @objc top-level class

"},"Other Classes.html#/s:C17MiscJazzyFeatures21TopLevelSwiftSubclass":{"name":"TopLevelSwiftSubclass","abstract":"

SUPPORTED: top-level Swift subclasses

"},"Other Classes.html#/s:C17MiscJazzyFeatures25UndocumentedTopLevelClass":{"name":"UndocumentedTopLevelClass","abstract":"

Undocumented

"},"Classes/ClassWithInitializers.html":{"name":"ClassWithInitializers","abstract":"

Class with initializers

"},"Classes/TopLevelClass.html":{"name":"TopLevelClass","abstract":"

Class with multiple nesting levels

"},"Enums/UndocumentedEnum.html#/s:FO17MiscJazzyFeatures16UndocumentedEnum17undocumentedValueFMS0_S0_":{"name":"undocumentedValue","abstract":"

Undocumented

","parent_name":"UndocumentedEnum"},"Yang.html#/s:C17MiscJazzyFeatures20TopLevelObjCSubclass":{"name":"TopLevelObjCSubclass","abstract":"

SUPPORTED: top-level Objective-C subclasses

"},"Enums/UndocumentedEnum.html":{"name":"UndocumentedEnum","abstract":"

Undocumented

"},"Yin.html#/s:C17MiscJazzyFeatures19PublicTopLevelClass":{"name":"PublicTopLevelClass","abstract":"

SUPPORTED: public top-level class

"},"Yin.html#/s:C17MiscJazzyFeaturesP33_72F27992F5E059C6D84AD5FC86B1B76B20PrivateTopLevelClass":{"name":"PrivateTopLevelClass","abstract":"

SUPPORTED: private top-level class

"},"Yin.html#/s:v17MiscJazzyFeatures16documentedGlobalSb":{"name":"documentedGlobal","abstract":"

SUPPORTED: documented global

"},"example-1.html":{"name":"Example 1"},"example-2.html":{"name":"Example 2"},"Guides.html":{"name":"Guides"},"Yin.html":{"name":"Yin"},"Yang.html":{"name":"Yang"},"Other Classes.html":{"name":"Other Classes","abstract":"

The following classes are available globally.

"},"Other Global Variables.html":{"name":"Other Global Variables","abstract":"

The following global variables are available globally.

"},"Other Enums.html":{"name":"Other Enums","abstract":"

The following enums are available globally.

"},"Other Extensions.html":{"name":"Other Extensions","abstract":"

The following extensions are available globally.

"},"Other Functions.html":{"name":"Other Functions","abstract":"

The following functions are available globally.

"}} \ No newline at end of file +{"Structs/GenericStruct.html#/s:vV17MiscJazzyFeatures13GenericStruct1tx":{"name":"t","abstract":"

Undocumented

","parent_name":"GenericStruct"},"Structs/GenericStruct.html":{"name":"GenericStruct","abstract":"

A generic structure.

"},"Functions/_2F_28_5F_3A_5F_3A_29.html#/s:tF17MiscJazzyFeaturesoi1durFTxx_T_L_1TMx":{"name":"T","parent_name":"/(_:_:)"},"Other Functions.html#/s:F17MiscJazzyFeatures9functionAFTSb10bParameterSb_Sb":{"name":"functionA(_:bParameter:)","abstract":"

Function (recommended documentation comment style)

"},"Other Functions.html#/s:F17MiscJazzyFeatures9functionBFSbSb":{"name":"functionB(_:)","abstract":"

Function (alternate documentation comment style)

"},"Other Functions.html#/s:F17MiscJazzyFeatures9functionCFSbSb":{"name":"functionC(_:)","abstract":"

Function (non‐standard documentation comment style)

"},"Other Functions.html#/s:F17MiscJazzyFeatures9functionDFSbSb":{"name":"functionD(_:)","abstract":"

Function (alternate non‐standard documentation comment style)

"},"Other Functions.html#/s:F17MiscJazzyFeatures9functionEFSbSb":{"name":"functionE(_:)","abstract":"

Function (alternate documentation comment style #2)

"},"Functions/_2F_28_5F_3A_5F_3A_29.html":{"name":"/(_:_:)","abstract":"

Function with characters unsafe for filenames.

"},"Extensions/String/CharacterView.html#/s:FE17MiscJazzyFeaturesVSS13CharacterView2eeFT_T_":{"name":"ee()","abstract":"

Method from an extension

","parent_name":"CharacterView"},"Extensions/String/CharacterView.html":{"name":"CharacterView","abstract":"

Extension of a nested external class

","parent_name":"String"},"Extensions/NSObject.html#/s:FE17MiscJazzyFeaturesCSo8NSObject2eeFT_T_":{"name":"ee()","abstract":"

Method from an extension

","parent_name":"NSObject"},"Extensions/NSObject.html":{"name":"NSObject","abstract":"

Extension of top-level external class

"},"Extensions/String.html":{"name":"String"},"Enums/DocumentedEnum.html#/s:FO17MiscJazzyFeatures14DocumentedEnum15documentedValueFMS0_S0_":{"name":"documentedValue","abstract":"

SUPPORTED: documented enum element

","parent_name":"DocumentedEnum"},"Enums/DocumentedEnum.html":{"name":"DocumentedEnum","abstract":"

SUPPORTED: documented enum

"},"Other Global Variables.html#/s:v17MiscJazzyFeatures18undocumentedGlobalSb":{"name":"undocumentedGlobal","abstract":"

Undocumented

"},"Classes/Operators.html#/s:ZFC17MiscJazzyFeatures9Operatorsoi1lFTOS_14DocumentedEnumS1__Sb":{"name":"<(_:_:)","abstract":"

Function with characters unsafe for html.

","parent_name":"Operators"},"Classes/TopLevelClass/NestedLevel1/NestedLevel2.html#/s:FCCC17MiscJazzyFeatures13TopLevelClass12NestedLevel112NestedLevel23nn2FT_T_":{"name":"nn2()","abstract":"

Nested-2 method

","parent_name":"NestedLevel2"},"Classes/TopLevelClass/NestedLevel1/NestedLevel2.html#/s:FCCC17MiscJazzyFeatures13TopLevelClass12NestedLevel112NestedLevel22ffFT_T_":{"name":"ff()","abstract":"

Method from a doubly-nested extension

","parent_name":"NestedLevel2"},"Classes/TopLevelClass/NestedLevel1.html#/s:FCC17MiscJazzyFeatures13TopLevelClass12NestedLevel13nn1FT_T_":{"name":"nn1()","abstract":"

Nested method

","parent_name":"NestedLevel1"},"Classes/TopLevelClass/NestedLevel1/NestedLevel2.html":{"name":"NestedLevel2","abstract":"

Undocumented

","parent_name":"NestedLevel1"},"Classes/TopLevelClass.html#/s:FC17MiscJazzyFeatures13TopLevelClass2ttFT_T_":{"name":"tt()","abstract":"

Top level method

","parent_name":"TopLevelClass"},"Classes/TopLevelClass/NestedLevel1.html":{"name":"NestedLevel1","abstract":"

Undocumented

","parent_name":"TopLevelClass"},"Classes/ClassWithInitializers.html#/s:FC17MiscJazzyFeatures21ClassWithInitializerscFT_S0_":{"name":"init()","abstract":"

Empty init

","parent_name":"ClassWithInitializers"},"Classes/ClassWithInitializers.html#/s:FC17MiscJazzyFeatures21ClassWithInitializerscFT1aT__S0_":{"name":"init(a:)","abstract":"

Parameterized init

","parent_name":"ClassWithInitializers"},"Classes/ClassWithInitializers.html#/s:FC17MiscJazzyFeatures21ClassWithInitializerscFT1bT__S0_":{"name":"init(b:)","abstract":"

Undocumented

","parent_name":"ClassWithInitializers"},"Classes/ClassWithInitializers.html#/s:FC17MiscJazzyFeatures21ClassWithInitializers2eeFT_T_":{"name":"ee()","abstract":"

Method from an extension

","parent_name":"ClassWithInitializers"},"Classes/ImplicitlyInternalTopLevelClass/NestedClass.html#/s:FCC17MiscJazzyFeatures31ImplicitlyInternalTopLevelClass11NestedClass2eeFT_T_":{"name":"ee()","abstract":"

Method from an extension

","parent_name":"NestedClass"},"Classes/ImplicitlyInternalTopLevelClass/NestedClass.html":{"name":"NestedClass","abstract":"

SUPPORTED: Nested class

","parent_name":"ImplicitlyInternalTopLevelClass"},"Classes/MiscMarkdown.html#/s:FC17MiscJazzyFeatures12MiscMarkdown11linespacingFT_T_":{"name":"linespacing()","abstract":"

Blank line not required before:

","parent_name":"MiscMarkdown"},"Classes/MiscMarkdown.html":{"name":"MiscMarkdown","abstract":"

A class to demonstrate miscellaneous markdown formatting behaviors

"},"Classes/ImplicitlyInternalTopLevelClass.html":{"name":"ImplicitlyInternalTopLevelClass","abstract":"

SUPPORTED: implicitly internal top-level class

"},"Other Classes.html#/s:C17MiscJazzyFeatures31ExplicitlyInternalTopLevelClass":{"name":"ExplicitlyInternalTopLevelClass","abstract":"

SUPPORTED: explicitly internal top-level class

"},"Other Classes.html#/s:C17MiscJazzyFeatures17ObjCTopLevelClass":{"name":"ObjCTopLevelClass","abstract":"

SUPPORTED: @objc top-level class

"},"Other Classes.html#/s:C17MiscJazzyFeatures21TopLevelSwiftSubclass":{"name":"TopLevelSwiftSubclass","abstract":"

SUPPORTED: top-level Swift subclasses

"},"Other Classes.html#/s:C17MiscJazzyFeatures25UndocumentedTopLevelClass":{"name":"UndocumentedTopLevelClass","abstract":"

Undocumented

"},"Classes/ClassWithInitializers.html":{"name":"ClassWithInitializers","abstract":"

Class with initializers

"},"Classes/TopLevelClass.html":{"name":"TopLevelClass","abstract":"

Class with multiple nesting levels

"},"Classes/Operators.html":{"name":"Operators","abstract":"

Undocumented

"},"Enums/UndocumentedEnum.html#/s:FO17MiscJazzyFeatures16UndocumentedEnum17undocumentedValueFMS0_S0_":{"name":"undocumentedValue","abstract":"

Undocumented

","parent_name":"UndocumentedEnum"},"Yang.html#/s:C17MiscJazzyFeatures20TopLevelObjCSubclass":{"name":"TopLevelObjCSubclass","abstract":"

SUPPORTED: top-level Objective-C subclasses

"},"Enums/UndocumentedEnum.html":{"name":"UndocumentedEnum","abstract":"

Undocumented

"},"Yin.html#/s:C17MiscJazzyFeatures19PublicTopLevelClass":{"name":"PublicTopLevelClass","abstract":"

SUPPORTED: public top-level class

"},"Yin.html#/s:C17MiscJazzyFeaturesP33_72F27992F5E059C6D84AD5FC86B1B76B20PrivateTopLevelClass":{"name":"PrivateTopLevelClass","abstract":"

SUPPORTED: private top-level class

"},"Yin.html#/s:v17MiscJazzyFeatures16documentedGlobalSb":{"name":"documentedGlobal","abstract":"

SUPPORTED: documented global

"},"example-1.html":{"name":"Example 1"},"example-2.html":{"name":"Example 2"},"Guides.html":{"name":"Guides"},"Yin.html":{"name":"Yin"},"Yang.html":{"name":"Yang"},"Other Classes.html":{"name":"Other Classes","abstract":"

The following classes are available globally.

"},"Other Global Variables.html":{"name":"Other Global Variables","abstract":"

The following global variables are available globally.

"},"Other Enums.html":{"name":"Other Enums","abstract":"

The following enums are available globally.

"},"Other Extensions.html":{"name":"Other Extensions","abstract":"

The following extensions are available globally.

"},"Other Functions.html":{"name":"Other Functions","abstract":"

The following functions are available globally.

"},"Other Structs.html":{"name":"Other Structs","abstract":"

The following structs are available globally.

"}} \ No newline at end of file diff --git a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/docSet.dsidx.csv b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/docSet.dsidx.csv index 11a98ae61..e2ad99de4 100644 --- a/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/docSet.dsidx.csv +++ b/misc_jazzy_features/after/docs/docsets/MiscJazzyFeatures.docset/Contents/Resources/docSet.dsidx.csv @@ -1,53 +1,58 @@ id,name,type,path -1,T,Parameter,Functions/_2F_28_5F_3A_5F_3A_29.html#/s:tF17MiscJazzyFeaturesoi1durFTxx_T_L_1TMx -2,functionA(_:bParameter:),Function,"Other Functions.html#/s:F17MiscJazzyFeatures9functionAFTSb10bParameterSb_Sb" -3,functionB(_:),Function,"Other Functions.html#/s:F17MiscJazzyFeatures9functionBFSbSb" -4,functionC(_:),Function,"Other Functions.html#/s:F17MiscJazzyFeatures9functionCFSbSb" -5,functionD(_:),Function,"Other Functions.html#/s:F17MiscJazzyFeatures9functionDFSbSb" -6,functionE(_:),Function,"Other Functions.html#/s:F17MiscJazzyFeatures9functionEFSbSb" -7,/(_:_:),Function,Functions/_2F_28_5F_3A_5F_3A_29.html -8,ee(),Method,Extensions/String/CharacterView.html#/s:FE17MiscJazzyFeaturesVSS13CharacterView2eeFT_T_ -9,CharacterView,Extension,Extensions/String/CharacterView.html -10,ee(),Method,Extensions/NSObject.html#/s:FE17MiscJazzyFeaturesCSo8NSObject2eeFT_T_ -11,NSObject,Extension,Extensions/NSObject.html -12,String,Extension,Extensions/String.html -13,documentedValue,Element,Enums/DocumentedEnum.html#/s:FO17MiscJazzyFeatures14DocumentedEnum15documentedValueFMS0_S0_ -14,DocumentedEnum,Enum,Enums/DocumentedEnum.html -15,undocumentedGlobal,Global,"Other Global Variables.html#/s:v17MiscJazzyFeatures18undocumentedGlobalSb" -16,nn2(),Method,Classes/TopLevelClass/NestedLevel1/NestedLevel2.html#/s:FCCC17MiscJazzyFeatures13TopLevelClass12NestedLevel112NestedLevel23nn2FT_T_ -17,ff(),Method,Classes/TopLevelClass/NestedLevel1/NestedLevel2.html#/s:FCCC17MiscJazzyFeatures13TopLevelClass12NestedLevel112NestedLevel22ffFT_T_ -18,nn1(),Method,Classes/TopLevelClass/NestedLevel1.html#/s:FCC17MiscJazzyFeatures13TopLevelClass12NestedLevel13nn1FT_T_ -19,NestedLevel2,Class,Classes/TopLevelClass/NestedLevel1/NestedLevel2.html -20,tt(),Method,Classes/TopLevelClass.html#/s:FC17MiscJazzyFeatures13TopLevelClass2ttFT_T_ -21,NestedLevel1,Class,Classes/TopLevelClass/NestedLevel1.html -22,init(),Method,Classes/ClassWithInitializers.html#/s:FC17MiscJazzyFeatures21ClassWithInitializerscFT_S0_ -23,init(a:),Method,Classes/ClassWithInitializers.html#/s:FC17MiscJazzyFeatures21ClassWithInitializerscFT1aT__S0_ -24,init(b:),Method,Classes/ClassWithInitializers.html#/s:FC17MiscJazzyFeatures21ClassWithInitializerscFT1bT__S0_ -25,ee(),Method,Classes/ClassWithInitializers.html#/s:FC17MiscJazzyFeatures21ClassWithInitializers2eeFT_T_ -26,ee(),Method,Classes/ImplicitlyInternalTopLevelClass/NestedClass.html#/s:FCC17MiscJazzyFeatures31ImplicitlyInternalTopLevelClass11NestedClass2eeFT_T_ -27,NestedClass,Class,Classes/ImplicitlyInternalTopLevelClass/NestedClass.html -28,linespacing(),Method,Classes/MiscMarkdown.html#/s:FC17MiscJazzyFeatures12MiscMarkdown11linespacingFT_T_ -29,MiscMarkdown,Class,Classes/MiscMarkdown.html -30,ImplicitlyInternalTopLevelClass,Class,Classes/ImplicitlyInternalTopLevelClass.html -31,ExplicitlyInternalTopLevelClass,Class,"Other Classes.html#/s:C17MiscJazzyFeatures31ExplicitlyInternalTopLevelClass" -32,ObjCTopLevelClass,Class,"Other Classes.html#/s:C17MiscJazzyFeatures17ObjCTopLevelClass" -33,TopLevelSwiftSubclass,Class,"Other Classes.html#/s:C17MiscJazzyFeatures21TopLevelSwiftSubclass" -34,UndocumentedTopLevelClass,Class,"Other Classes.html#/s:C17MiscJazzyFeatures25UndocumentedTopLevelClass" -35,ClassWithInitializers,Class,Classes/ClassWithInitializers.html -36,TopLevelClass,Class,Classes/TopLevelClass.html -37,undocumentedValue,Element,Enums/UndocumentedEnum.html#/s:FO17MiscJazzyFeatures16UndocumentedEnum17undocumentedValueFMS0_S0_ -38,TopLevelObjCSubclass,Class,Yang.html#/s:C17MiscJazzyFeatures20TopLevelObjCSubclass -39,UndocumentedEnum,Enum,Enums/UndocumentedEnum.html -40,PublicTopLevelClass,Class,Yin.html#/s:C17MiscJazzyFeatures19PublicTopLevelClass -41,PrivateTopLevelClass,Class,Yin.html#/s:C17MiscJazzyFeaturesP33_72F27992F5E059C6D84AD5FC86B1B76B20PrivateTopLevelClass -42,documentedGlobal,Global,Yin.html#/s:v17MiscJazzyFeatures16documentedGlobalSb -43,"Example 1",Guide,example-1.html -44,"Example 2",Guide,example-2.html -45,Guides,,Guides.html -46,Yin,,Yin.html -47,Yang,,Yang.html -48,"Other Classes",,"Other Classes.html" -49,"Other Global Variables",,"Other Global Variables.html" -50,"Other Enums",,"Other Enums.html" -51,"Other Extensions",,"Other Extensions.html" -52,"Other Functions",,"Other Functions.html" +1,t,Property,Structs/GenericStruct.html#/s:vV17MiscJazzyFeatures13GenericStruct1tx +2,GenericStruct,Struct,Structs/GenericStruct.html +3,T,Parameter,Functions/_2F_28_5F_3A_5F_3A_29.html#/s:tF17MiscJazzyFeaturesoi1durFTxx_T_L_1TMx +4,functionA(_:bParameter:),Function,"Other Functions.html#/s:F17MiscJazzyFeatures9functionAFTSb10bParameterSb_Sb" +5,functionB(_:),Function,"Other Functions.html#/s:F17MiscJazzyFeatures9functionBFSbSb" +6,functionC(_:),Function,"Other Functions.html#/s:F17MiscJazzyFeatures9functionCFSbSb" +7,functionD(_:),Function,"Other Functions.html#/s:F17MiscJazzyFeatures9functionDFSbSb" +8,functionE(_:),Function,"Other Functions.html#/s:F17MiscJazzyFeatures9functionEFSbSb" +9,/(_:_:),Function,Functions/_2F_28_5F_3A_5F_3A_29.html +10,ee(),Method,Extensions/String/CharacterView.html#/s:FE17MiscJazzyFeaturesVSS13CharacterView2eeFT_T_ +11,CharacterView,Extension,Extensions/String/CharacterView.html +12,ee(),Method,Extensions/NSObject.html#/s:FE17MiscJazzyFeaturesCSo8NSObject2eeFT_T_ +13,NSObject,Extension,Extensions/NSObject.html +14,String,Extension,Extensions/String.html +15,documentedValue,Element,Enums/DocumentedEnum.html#/s:FO17MiscJazzyFeatures14DocumentedEnum15documentedValueFMS0_S0_ +16,DocumentedEnum,Enum,Enums/DocumentedEnum.html +17,undocumentedGlobal,Global,"Other Global Variables.html#/s:v17MiscJazzyFeatures18undocumentedGlobalSb" +18,<(_:_:),Method,Classes/Operators.html#/s:ZFC17MiscJazzyFeatures9Operatorsoi1lFTOS_14DocumentedEnumS1__Sb +19,nn2(),Method,Classes/TopLevelClass/NestedLevel1/NestedLevel2.html#/s:FCCC17MiscJazzyFeatures13TopLevelClass12NestedLevel112NestedLevel23nn2FT_T_ +20,ff(),Method,Classes/TopLevelClass/NestedLevel1/NestedLevel2.html#/s:FCCC17MiscJazzyFeatures13TopLevelClass12NestedLevel112NestedLevel22ffFT_T_ +21,nn1(),Method,Classes/TopLevelClass/NestedLevel1.html#/s:FCC17MiscJazzyFeatures13TopLevelClass12NestedLevel13nn1FT_T_ +22,NestedLevel2,Class,Classes/TopLevelClass/NestedLevel1/NestedLevel2.html +23,tt(),Method,Classes/TopLevelClass.html#/s:FC17MiscJazzyFeatures13TopLevelClass2ttFT_T_ +24,NestedLevel1,Class,Classes/TopLevelClass/NestedLevel1.html +25,init(),Method,Classes/ClassWithInitializers.html#/s:FC17MiscJazzyFeatures21ClassWithInitializerscFT_S0_ +26,init(a:),Method,Classes/ClassWithInitializers.html#/s:FC17MiscJazzyFeatures21ClassWithInitializerscFT1aT__S0_ +27,init(b:),Method,Classes/ClassWithInitializers.html#/s:FC17MiscJazzyFeatures21ClassWithInitializerscFT1bT__S0_ +28,ee(),Method,Classes/ClassWithInitializers.html#/s:FC17MiscJazzyFeatures21ClassWithInitializers2eeFT_T_ +29,ee(),Method,Classes/ImplicitlyInternalTopLevelClass/NestedClass.html#/s:FCC17MiscJazzyFeatures31ImplicitlyInternalTopLevelClass11NestedClass2eeFT_T_ +30,NestedClass,Class,Classes/ImplicitlyInternalTopLevelClass/NestedClass.html +31,linespacing(),Method,Classes/MiscMarkdown.html#/s:FC17MiscJazzyFeatures12MiscMarkdown11linespacingFT_T_ +32,MiscMarkdown,Class,Classes/MiscMarkdown.html +33,ImplicitlyInternalTopLevelClass,Class,Classes/ImplicitlyInternalTopLevelClass.html +34,ExplicitlyInternalTopLevelClass,Class,"Other Classes.html#/s:C17MiscJazzyFeatures31ExplicitlyInternalTopLevelClass" +35,ObjCTopLevelClass,Class,"Other Classes.html#/s:C17MiscJazzyFeatures17ObjCTopLevelClass" +36,TopLevelSwiftSubclass,Class,"Other Classes.html#/s:C17MiscJazzyFeatures21TopLevelSwiftSubclass" +37,UndocumentedTopLevelClass,Class,"Other Classes.html#/s:C17MiscJazzyFeatures25UndocumentedTopLevelClass" +38,ClassWithInitializers,Class,Classes/ClassWithInitializers.html +39,TopLevelClass,Class,Classes/TopLevelClass.html +40,Operators,Class,Classes/Operators.html +41,undocumentedValue,Element,Enums/UndocumentedEnum.html#/s:FO17MiscJazzyFeatures16UndocumentedEnum17undocumentedValueFMS0_S0_ +42,TopLevelObjCSubclass,Class,Yang.html#/s:C17MiscJazzyFeatures20TopLevelObjCSubclass +43,UndocumentedEnum,Enum,Enums/UndocumentedEnum.html +44,PublicTopLevelClass,Class,Yin.html#/s:C17MiscJazzyFeatures19PublicTopLevelClass +45,PrivateTopLevelClass,Class,Yin.html#/s:C17MiscJazzyFeaturesP33_72F27992F5E059C6D84AD5FC86B1B76B20PrivateTopLevelClass +46,documentedGlobal,Global,Yin.html#/s:v17MiscJazzyFeatures16documentedGlobalSb +47,"Example 1",Guide,example-1.html +48,"Example 2",Guide,example-2.html +49,Guides,,Guides.html +50,Yin,,Yin.html +51,Yang,,Yang.html +52,"Other Classes",,"Other Classes.html" +53,"Other Global Variables",,"Other Global Variables.html" +54,"Other Enums",,"Other Enums.html" +55,"Other Extensions",,"Other Extensions.html" +56,"Other Functions",,"Other Functions.html" +57,"Other Structs",,"Other Structs.html" diff --git a/misc_jazzy_features/after/docs/example-1.html b/misc_jazzy_features/after/docs/example-1.html index 81c76a01a..fe1791316 100644 --- a/misc_jazzy_features/after/docs/example-1.html +++ b/misc_jazzy_features/after/docs/example-1.html @@ -106,6 +106,9 @@ + @@ -173,6 +176,14 @@ +
@@ -182,6 +193,8 @@

Example Docs File 1

+

Autolink to DocumentedEnum.documentedValue.

+ diff --git a/misc_jazzy_features/after/docs/example-2.html b/misc_jazzy_features/after/docs/example-2.html index a2f7a6e67..4928b544b 100644 --- a/misc_jazzy_features/after/docs/example-2.html +++ b/misc_jazzy_features/after/docs/example-2.html @@ -106,6 +106,9 @@ + @@ -173,6 +176,14 @@ +
diff --git a/misc_jazzy_features/after/docs/index.html b/misc_jazzy_features/after/docs/index.html index f691c40bc..6dfeed28b 100644 --- a/misc_jazzy_features/after/docs/index.html +++ b/misc_jazzy_features/after/docs/index.html @@ -106,6 +106,9 @@ + @@ -173,6 +176,14 @@ +
@@ -183,9 +194,15 @@

Misc Jazzy Features

-

Sample fixtures for miscellanious Jazzy features

+

Sample fixtures for miscellaneous Jazzy features

+

Autolink to DocumentedEnum.documentedValue.

+ +

Autolink to Operators.<(...).

+ +

Autolink to GenericStruct<Anything> links to GenericStruct.

+ diff --git a/misc_jazzy_features/after/docs/search.json b/misc_jazzy_features/after/docs/search.json index a9d8d8029..d3626e4fd 100644 --- a/misc_jazzy_features/after/docs/search.json +++ b/misc_jazzy_features/after/docs/search.json @@ -1 +1 @@ -{"Functions/_2F_28_5F_3A_5F_3A_29.html#/s:tF17MiscJazzyFeaturesoi1durFTxx_T_L_1TMx":{"name":"T","parent_name":"/(_:_:)"},"Other Functions.html#/s:F17MiscJazzyFeatures9functionAFTSb10bParameterSb_Sb":{"name":"functionA(_:bParameter:)","abstract":"

Function (recommended documentation comment style)

"},"Other Functions.html#/s:F17MiscJazzyFeatures9functionBFSbSb":{"name":"functionB(_:)","abstract":"

Function (alternate documentation comment style)

"},"Other Functions.html#/s:F17MiscJazzyFeatures9functionCFSbSb":{"name":"functionC(_:)","abstract":"

Function (non‐standard documentation comment style)

"},"Other Functions.html#/s:F17MiscJazzyFeatures9functionDFSbSb":{"name":"functionD(_:)","abstract":"

Function (alternate non‐standard documentation comment style)

"},"Other Functions.html#/s:F17MiscJazzyFeatures9functionEFSbSb":{"name":"functionE(_:)","abstract":"

Function (alternate documentation comment style #2)

"},"Functions/_2F_28_5F_3A_5F_3A_29.html":{"name":"/(_:_:)","abstract":"

Function with characters unsafe for filenames.

"},"Extensions/String/CharacterView.html#/s:FE17MiscJazzyFeaturesVSS13CharacterView2eeFT_T_":{"name":"ee()","abstract":"

Method from an extension

","parent_name":"CharacterView"},"Extensions/String/CharacterView.html":{"name":"CharacterView","abstract":"

Extension of a nested external class

","parent_name":"String"},"Extensions/NSObject.html#/s:FE17MiscJazzyFeaturesCSo8NSObject2eeFT_T_":{"name":"ee()","abstract":"

Method from an extension

","parent_name":"NSObject"},"Extensions/NSObject.html":{"name":"NSObject","abstract":"

Extension of top-level external class

"},"Extensions/String.html":{"name":"String"},"Enums/DocumentedEnum.html#/s:FO17MiscJazzyFeatures14DocumentedEnum15documentedValueFMS0_S0_":{"name":"documentedValue","abstract":"

SUPPORTED: documented enum element

","parent_name":"DocumentedEnum"},"Enums/DocumentedEnum.html":{"name":"DocumentedEnum","abstract":"

SUPPORTED: documented enum

"},"Other Global Variables.html#/s:v17MiscJazzyFeatures18undocumentedGlobalSb":{"name":"undocumentedGlobal","abstract":"

Undocumented

"},"Classes/TopLevelClass/NestedLevel1/NestedLevel2.html#/s:FCCC17MiscJazzyFeatures13TopLevelClass12NestedLevel112NestedLevel23nn2FT_T_":{"name":"nn2()","abstract":"

Nested-2 method

","parent_name":"NestedLevel2"},"Classes/TopLevelClass/NestedLevel1/NestedLevel2.html#/s:FCCC17MiscJazzyFeatures13TopLevelClass12NestedLevel112NestedLevel22ffFT_T_":{"name":"ff()","abstract":"

Method from a doubly-nested extension

","parent_name":"NestedLevel2"},"Classes/TopLevelClass/NestedLevel1.html#/s:FCC17MiscJazzyFeatures13TopLevelClass12NestedLevel13nn1FT_T_":{"name":"nn1()","abstract":"

Nested method

","parent_name":"NestedLevel1"},"Classes/TopLevelClass/NestedLevel1/NestedLevel2.html":{"name":"NestedLevel2","abstract":"

Undocumented

","parent_name":"NestedLevel1"},"Classes/TopLevelClass.html#/s:FC17MiscJazzyFeatures13TopLevelClass2ttFT_T_":{"name":"tt()","abstract":"

Top level method

","parent_name":"TopLevelClass"},"Classes/TopLevelClass/NestedLevel1.html":{"name":"NestedLevel1","abstract":"

Undocumented

","parent_name":"TopLevelClass"},"Classes/ClassWithInitializers.html#/s:FC17MiscJazzyFeatures21ClassWithInitializerscFT_S0_":{"name":"init()","abstract":"

Empty init

","parent_name":"ClassWithInitializers"},"Classes/ClassWithInitializers.html#/s:FC17MiscJazzyFeatures21ClassWithInitializerscFT1aT__S0_":{"name":"init(a:)","abstract":"

Parameterized init

","parent_name":"ClassWithInitializers"},"Classes/ClassWithInitializers.html#/s:FC17MiscJazzyFeatures21ClassWithInitializerscFT1bT__S0_":{"name":"init(b:)","abstract":"

Undocumented

","parent_name":"ClassWithInitializers"},"Classes/ClassWithInitializers.html#/s:FC17MiscJazzyFeatures21ClassWithInitializers2eeFT_T_":{"name":"ee()","abstract":"

Method from an extension

","parent_name":"ClassWithInitializers"},"Classes/ImplicitlyInternalTopLevelClass/NestedClass.html#/s:FCC17MiscJazzyFeatures31ImplicitlyInternalTopLevelClass11NestedClass2eeFT_T_":{"name":"ee()","abstract":"

Method from an extension

","parent_name":"NestedClass"},"Classes/ImplicitlyInternalTopLevelClass/NestedClass.html":{"name":"NestedClass","abstract":"

SUPPORTED: Nested class

","parent_name":"ImplicitlyInternalTopLevelClass"},"Classes/MiscMarkdown.html#/s:FC17MiscJazzyFeatures12MiscMarkdown11linespacingFT_T_":{"name":"linespacing()","abstract":"

Blank line not required before:

","parent_name":"MiscMarkdown"},"Classes/MiscMarkdown.html":{"name":"MiscMarkdown","abstract":"

A class to demonstrate miscellaneous markdown formatting behaviors

"},"Classes/ImplicitlyInternalTopLevelClass.html":{"name":"ImplicitlyInternalTopLevelClass","abstract":"

SUPPORTED: implicitly internal top-level class

"},"Other Classes.html#/s:C17MiscJazzyFeatures31ExplicitlyInternalTopLevelClass":{"name":"ExplicitlyInternalTopLevelClass","abstract":"

SUPPORTED: explicitly internal top-level class

"},"Other Classes.html#/s:C17MiscJazzyFeatures17ObjCTopLevelClass":{"name":"ObjCTopLevelClass","abstract":"

SUPPORTED: @objc top-level class

"},"Other Classes.html#/s:C17MiscJazzyFeatures21TopLevelSwiftSubclass":{"name":"TopLevelSwiftSubclass","abstract":"

SUPPORTED: top-level Swift subclasses

"},"Other Classes.html#/s:C17MiscJazzyFeatures25UndocumentedTopLevelClass":{"name":"UndocumentedTopLevelClass","abstract":"

Undocumented

"},"Classes/ClassWithInitializers.html":{"name":"ClassWithInitializers","abstract":"

Class with initializers

"},"Classes/TopLevelClass.html":{"name":"TopLevelClass","abstract":"

Class with multiple nesting levels

"},"Enums/UndocumentedEnum.html#/s:FO17MiscJazzyFeatures16UndocumentedEnum17undocumentedValueFMS0_S0_":{"name":"undocumentedValue","abstract":"

Undocumented

","parent_name":"UndocumentedEnum"},"Yang.html#/s:C17MiscJazzyFeatures20TopLevelObjCSubclass":{"name":"TopLevelObjCSubclass","abstract":"

SUPPORTED: top-level Objective-C subclasses

"},"Enums/UndocumentedEnum.html":{"name":"UndocumentedEnum","abstract":"

Undocumented

"},"Yin.html#/s:C17MiscJazzyFeatures19PublicTopLevelClass":{"name":"PublicTopLevelClass","abstract":"

SUPPORTED: public top-level class

"},"Yin.html#/s:C17MiscJazzyFeaturesP33_72F27992F5E059C6D84AD5FC86B1B76B20PrivateTopLevelClass":{"name":"PrivateTopLevelClass","abstract":"

SUPPORTED: private top-level class

"},"Yin.html#/s:v17MiscJazzyFeatures16documentedGlobalSb":{"name":"documentedGlobal","abstract":"

SUPPORTED: documented global

"},"example-1.html":{"name":"Example 1"},"example-2.html":{"name":"Example 2"},"Guides.html":{"name":"Guides"},"Yin.html":{"name":"Yin"},"Yang.html":{"name":"Yang"},"Other Classes.html":{"name":"Other Classes","abstract":"

The following classes are available globally.

"},"Other Global Variables.html":{"name":"Other Global Variables","abstract":"

The following global variables are available globally.

"},"Other Enums.html":{"name":"Other Enums","abstract":"

The following enums are available globally.

"},"Other Extensions.html":{"name":"Other Extensions","abstract":"

The following extensions are available globally.

"},"Other Functions.html":{"name":"Other Functions","abstract":"

The following functions are available globally.

"}} \ No newline at end of file +{"Structs/GenericStruct.html#/s:vV17MiscJazzyFeatures13GenericStruct1tx":{"name":"t","abstract":"

Undocumented

","parent_name":"GenericStruct"},"Structs/GenericStruct.html":{"name":"GenericStruct","abstract":"

A generic structure.

"},"Functions/_2F_28_5F_3A_5F_3A_29.html#/s:tF17MiscJazzyFeaturesoi1durFTxx_T_L_1TMx":{"name":"T","parent_name":"/(_:_:)"},"Other Functions.html#/s:F17MiscJazzyFeatures9functionAFTSb10bParameterSb_Sb":{"name":"functionA(_:bParameter:)","abstract":"

Function (recommended documentation comment style)

"},"Other Functions.html#/s:F17MiscJazzyFeatures9functionBFSbSb":{"name":"functionB(_:)","abstract":"

Function (alternate documentation comment style)

"},"Other Functions.html#/s:F17MiscJazzyFeatures9functionCFSbSb":{"name":"functionC(_:)","abstract":"

Function (non‐standard documentation comment style)

"},"Other Functions.html#/s:F17MiscJazzyFeatures9functionDFSbSb":{"name":"functionD(_:)","abstract":"

Function (alternate non‐standard documentation comment style)

"},"Other Functions.html#/s:F17MiscJazzyFeatures9functionEFSbSb":{"name":"functionE(_:)","abstract":"

Function (alternate documentation comment style #2)

"},"Functions/_2F_28_5F_3A_5F_3A_29.html":{"name":"/(_:_:)","abstract":"

Function with characters unsafe for filenames.

"},"Extensions/String/CharacterView.html#/s:FE17MiscJazzyFeaturesVSS13CharacterView2eeFT_T_":{"name":"ee()","abstract":"

Method from an extension

","parent_name":"CharacterView"},"Extensions/String/CharacterView.html":{"name":"CharacterView","abstract":"

Extension of a nested external class

","parent_name":"String"},"Extensions/NSObject.html#/s:FE17MiscJazzyFeaturesCSo8NSObject2eeFT_T_":{"name":"ee()","abstract":"

Method from an extension

","parent_name":"NSObject"},"Extensions/NSObject.html":{"name":"NSObject","abstract":"

Extension of top-level external class

"},"Extensions/String.html":{"name":"String"},"Enums/DocumentedEnum.html#/s:FO17MiscJazzyFeatures14DocumentedEnum15documentedValueFMS0_S0_":{"name":"documentedValue","abstract":"

SUPPORTED: documented enum element

","parent_name":"DocumentedEnum"},"Enums/DocumentedEnum.html":{"name":"DocumentedEnum","abstract":"

SUPPORTED: documented enum

"},"Other Global Variables.html#/s:v17MiscJazzyFeatures18undocumentedGlobalSb":{"name":"undocumentedGlobal","abstract":"

Undocumented

"},"Classes/Operators.html#/s:ZFC17MiscJazzyFeatures9Operatorsoi1lFTOS_14DocumentedEnumS1__Sb":{"name":"<(_:_:)","abstract":"

Function with characters unsafe for html.

","parent_name":"Operators"},"Classes/TopLevelClass/NestedLevel1/NestedLevel2.html#/s:FCCC17MiscJazzyFeatures13TopLevelClass12NestedLevel112NestedLevel23nn2FT_T_":{"name":"nn2()","abstract":"

Nested-2 method

","parent_name":"NestedLevel2"},"Classes/TopLevelClass/NestedLevel1/NestedLevel2.html#/s:FCCC17MiscJazzyFeatures13TopLevelClass12NestedLevel112NestedLevel22ffFT_T_":{"name":"ff()","abstract":"

Method from a doubly-nested extension

","parent_name":"NestedLevel2"},"Classes/TopLevelClass/NestedLevel1.html#/s:FCC17MiscJazzyFeatures13TopLevelClass12NestedLevel13nn1FT_T_":{"name":"nn1()","abstract":"

Nested method

","parent_name":"NestedLevel1"},"Classes/TopLevelClass/NestedLevel1/NestedLevel2.html":{"name":"NestedLevel2","abstract":"

Undocumented

","parent_name":"NestedLevel1"},"Classes/TopLevelClass.html#/s:FC17MiscJazzyFeatures13TopLevelClass2ttFT_T_":{"name":"tt()","abstract":"

Top level method

","parent_name":"TopLevelClass"},"Classes/TopLevelClass/NestedLevel1.html":{"name":"NestedLevel1","abstract":"

Undocumented

","parent_name":"TopLevelClass"},"Classes/ClassWithInitializers.html#/s:FC17MiscJazzyFeatures21ClassWithInitializerscFT_S0_":{"name":"init()","abstract":"

Empty init

","parent_name":"ClassWithInitializers"},"Classes/ClassWithInitializers.html#/s:FC17MiscJazzyFeatures21ClassWithInitializerscFT1aT__S0_":{"name":"init(a:)","abstract":"

Parameterized init

","parent_name":"ClassWithInitializers"},"Classes/ClassWithInitializers.html#/s:FC17MiscJazzyFeatures21ClassWithInitializerscFT1bT__S0_":{"name":"init(b:)","abstract":"

Undocumented

","parent_name":"ClassWithInitializers"},"Classes/ClassWithInitializers.html#/s:FC17MiscJazzyFeatures21ClassWithInitializers2eeFT_T_":{"name":"ee()","abstract":"

Method from an extension

","parent_name":"ClassWithInitializers"},"Classes/ImplicitlyInternalTopLevelClass/NestedClass.html#/s:FCC17MiscJazzyFeatures31ImplicitlyInternalTopLevelClass11NestedClass2eeFT_T_":{"name":"ee()","abstract":"

Method from an extension

","parent_name":"NestedClass"},"Classes/ImplicitlyInternalTopLevelClass/NestedClass.html":{"name":"NestedClass","abstract":"

SUPPORTED: Nested class

","parent_name":"ImplicitlyInternalTopLevelClass"},"Classes/MiscMarkdown.html#/s:FC17MiscJazzyFeatures12MiscMarkdown11linespacingFT_T_":{"name":"linespacing()","abstract":"

Blank line not required before:

","parent_name":"MiscMarkdown"},"Classes/MiscMarkdown.html":{"name":"MiscMarkdown","abstract":"

A class to demonstrate miscellaneous markdown formatting behaviors

"},"Classes/ImplicitlyInternalTopLevelClass.html":{"name":"ImplicitlyInternalTopLevelClass","abstract":"

SUPPORTED: implicitly internal top-level class

"},"Other Classes.html#/s:C17MiscJazzyFeatures31ExplicitlyInternalTopLevelClass":{"name":"ExplicitlyInternalTopLevelClass","abstract":"

SUPPORTED: explicitly internal top-level class

"},"Other Classes.html#/s:C17MiscJazzyFeatures17ObjCTopLevelClass":{"name":"ObjCTopLevelClass","abstract":"

SUPPORTED: @objc top-level class

"},"Other Classes.html#/s:C17MiscJazzyFeatures21TopLevelSwiftSubclass":{"name":"TopLevelSwiftSubclass","abstract":"

SUPPORTED: top-level Swift subclasses

"},"Other Classes.html#/s:C17MiscJazzyFeatures25UndocumentedTopLevelClass":{"name":"UndocumentedTopLevelClass","abstract":"

Undocumented

"},"Classes/ClassWithInitializers.html":{"name":"ClassWithInitializers","abstract":"

Class with initializers

"},"Classes/TopLevelClass.html":{"name":"TopLevelClass","abstract":"

Class with multiple nesting levels

"},"Classes/Operators.html":{"name":"Operators","abstract":"

Undocumented

"},"Enums/UndocumentedEnum.html#/s:FO17MiscJazzyFeatures16UndocumentedEnum17undocumentedValueFMS0_S0_":{"name":"undocumentedValue","abstract":"

Undocumented

","parent_name":"UndocumentedEnum"},"Yang.html#/s:C17MiscJazzyFeatures20TopLevelObjCSubclass":{"name":"TopLevelObjCSubclass","abstract":"

SUPPORTED: top-level Objective-C subclasses

"},"Enums/UndocumentedEnum.html":{"name":"UndocumentedEnum","abstract":"

Undocumented

"},"Yin.html#/s:C17MiscJazzyFeatures19PublicTopLevelClass":{"name":"PublicTopLevelClass","abstract":"

SUPPORTED: public top-level class

"},"Yin.html#/s:C17MiscJazzyFeaturesP33_72F27992F5E059C6D84AD5FC86B1B76B20PrivateTopLevelClass":{"name":"PrivateTopLevelClass","abstract":"

SUPPORTED: private top-level class

"},"Yin.html#/s:v17MiscJazzyFeatures16documentedGlobalSb":{"name":"documentedGlobal","abstract":"

SUPPORTED: documented global

"},"example-1.html":{"name":"Example 1"},"example-2.html":{"name":"Example 2"},"Guides.html":{"name":"Guides"},"Yin.html":{"name":"Yin"},"Yang.html":{"name":"Yang"},"Other Classes.html":{"name":"Other Classes","abstract":"

The following classes are available globally.

"},"Other Global Variables.html":{"name":"Other Global Variables","abstract":"

The following global variables are available globally.

"},"Other Enums.html":{"name":"Other Enums","abstract":"

The following enums are available globally.

"},"Other Extensions.html":{"name":"Other Extensions","abstract":"

The following extensions are available globally.

"},"Other Functions.html":{"name":"Other Functions","abstract":"

The following functions are available globally.

"},"Other Structs.html":{"name":"Other Structs","abstract":"

The following structs are available globally.

"}} \ No newline at end of file diff --git a/misc_jazzy_features/after/docs/undocumented.json b/misc_jazzy_features/after/docs/undocumented.json index fe6ca62c6..5b98706c8 100644 --- a/misc_jazzy_features/after/docs/undocumented.json +++ b/misc_jazzy_features/after/docs/undocumented.json @@ -55,6 +55,20 @@ "symbol": "TopLevelClass.NestedLevel1.NestedLevel2", "symbol_kind": "source.lang.swift.decl.class", "warning": "undocumented" + }, + { + "file": "/misc_jazzy_features/MiscJazzyFeatures/Classes.swift", + "line": 130, + "symbol": "GenericStruct.t", + "symbol_kind": "source.lang.swift.decl.var.instance", + "warning": "undocumented" + }, + { + "file": "/misc_jazzy_features/MiscJazzyFeatures/Filenames.swift", + "line": 12, + "symbol": "Operators", + "symbol_kind": "source.lang.swift.decl.class", + "warning": "undocumented" } ], "source_directory": "/misc_jazzy_features" diff --git a/misc_jazzy_features/after/execution_output.txt b/misc_jazzy_features/after/execution_output.txt index a1e063fd1..bd833d96e 100644 --- a/misc_jazzy_features/after/execution_output.txt +++ b/misc_jazzy_features/after/execution_output.txt @@ -8,6 +8,6 @@ Parsing Filenames.swift (4/5) Parsing Ignored.swift (5/5) building site building search index -80% documentation coverage with 8 undocumented symbols -included 42 private, fileprivate, internal, public, or open symbols +78% documentation coverage with 10 undocumented symbols +included 46 private, fileprivate, internal, public, or open symbols jam out ♪♫ to your fresh new docs in `docs` diff --git a/misc_jazzy_features/before/Extra/Example 1.md b/misc_jazzy_features/before/Extra/Example 1.md index bb256d9ce..b3e1fccd0 100644 --- a/misc_jazzy_features/before/Extra/Example 1.md +++ b/misc_jazzy_features/before/Extra/Example 1.md @@ -1,2 +1,4 @@ # Example Docs File 1 + +Autolink to `DocumentedEnum.documentedValue`. diff --git a/misc_jazzy_features/before/MiscJazzyFeatures/Callouts.swift b/misc_jazzy_features/before/MiscJazzyFeatures/Callouts.swift index d76252d4e..eee88d3f0 100644 --- a/misc_jazzy_features/before/MiscJazzyFeatures/Callouts.swift +++ b/misc_jazzy_features/before/MiscJazzyFeatures/Callouts.swift @@ -15,6 +15,7 @@ /// ```swift /// aParameter /// ``` +/// Also see `functionB(_:)` and `DocumentedEnum.documentedValue` /// - bParameter: Another parameter /// /// - Returns: A result diff --git a/misc_jazzy_features/before/MiscJazzyFeatures/Classes.swift b/misc_jazzy_features/before/MiscJazzyFeatures/Classes.swift index 26b61c076..7bf8d010e 100644 --- a/misc_jazzy_features/before/MiscJazzyFeatures/Classes.swift +++ b/misc_jazzy_features/before/MiscJazzyFeatures/Classes.swift @@ -122,3 +122,10 @@ extension TopLevelClass.NestedLevel1.NestedLevel2 { /// Method from a doubly-nested extension func ff() {} } + +// MARK: Generics + +/// A generic structure. +struct GenericStruct { + var t: T +} diff --git a/misc_jazzy_features/before/MiscJazzyFeatures/Filenames.swift b/misc_jazzy_features/before/MiscJazzyFeatures/Filenames.swift index c70ea57e0..22d32a788 100644 --- a/misc_jazzy_features/before/MiscJazzyFeatures/Filenames.swift +++ b/misc_jazzy_features/before/MiscJazzyFeatures/Filenames.swift @@ -8,3 +8,10 @@ /// Function with characters unsafe for filenames. public func /(lhs: T, rhs: T) {} + +class Operators { + /// Function with characters unsafe for html. + public static func <(lhs: DocumentedEnum, rhs: DocumentedEnum) : Bool { + return false + } +} diff --git a/misc_jazzy_features/before/README.md b/misc_jazzy_features/before/README.md index 811f95c8e..33c9ca7c5 100644 --- a/misc_jazzy_features/before/README.md +++ b/misc_jazzy_features/before/README.md @@ -1,3 +1,9 @@ # Misc Jazzy Features -> Sample fixtures for miscellanious Jazzy features +> Sample fixtures for miscellaneous Jazzy features + +Autolink to `DocumentedEnum.documentedValue`. + +Autolink to `Operators.<(...)`. + +Autolink to `GenericStruct` links to `GenericStruct`. diff --git a/misc_jazzy_features/before/Sections/ClassWithInitializers.md b/misc_jazzy_features/before/Sections/ClassWithInitializers.md index 4539727bf..eaa532f99 100644 --- a/misc_jazzy_features/before/Sections/ClassWithInitializers.md +++ b/misc_jazzy_features/before/Sections/ClassWithInitializers.md @@ -1 +1,3 @@ -Example extra abstract to inject before default abstract of ClassWithInitializers \ No newline at end of file +Example extra abstract to inject before default abstract of ClassWithInitializers + +Autolink to `DocumentedEnum.documentedValue`. diff --git a/misc_jazzy_features/before/Sections/Guides.md b/misc_jazzy_features/before/Sections/Guides.md index 328cdbafa..f735f19c4 100644 --- a/misc_jazzy_features/before/Sections/Guides.md +++ b/misc_jazzy_features/before/Sections/Guides.md @@ -1 +1,3 @@ -> Example abstract for the Guides section \ No newline at end of file +> Example abstract for the Guides section + +Autolink to `DocumentedEnum.documentedValue`.