Skip to content

Commit 46b36d1

Browse files
danielrbrownedanielrbrowne
authored
Merge pull request #354 from pusher/feature/docs-improvements
Documentation improvements
2 parents 7b93c94 + 2f7954f commit 46b36d1

File tree

85 files changed

+29329
-5
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

85 files changed

+29329
-5
lines changed

‎README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Pusher Channels Swift Client (also works with Objective-C)
22

33
![Build Status](https://app.bitrise.io/app/3c6dac112b98e7fe.svg?token=n0z-aWua_Bc35kUGu4qpYg)
4-
![Languages](https://img.shields.io/badge/languages-swift%20%7C%20objc-orange.svg)
5-
[![Platform](https://img.shields.io/cocoapods/p/PusherSwift.svg?style=flat)](http://cocoadocs.org/docsets/PusherSwift)
6-
[![Cocoapods Compatible](https://img.shields.io/cocoapods/v/PusherSwift.svg)](https://img.shields.io/cocoapods/v/PusherSwift.svg)
7-
[![Carthage Compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
4+
[![codecov](https://codecov.io/gh/pusher/pusher-websocket-swift/branch/master/graph/badge.svg)](https://codecov.io/gh/pusher/pusher-websocket-swift)
5+
[![Latest Release](https://img.shields.io/github/v/release/pusher/pusher-websocket-swift)](https://github.com/pusher/pusher-websocket-swift/releases)
6+
[![API Docs](https://img.shields.io/badge/Docs-here!-lightgrey)](https://pusher.github.io/pusher-websocket-swift/)
7+
[![Supported Platforms](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fpusher%2Fpusher-websocket-swift%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/pusher/pusher-websocket-swift)
8+
[![Swift Versions](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fpusher%2Fpusher-websocket-swift%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/pusher/pusher-websocket-swift)
89
[![Twitter](https://img.shields.io/badge/twitter-@Pusher-blue.svg?style=flat)](http://twitter.com/Pusher)
910
[![GitHub license](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/pusher/pusher-websocket-swift/master/LICENSE.md)
10-
[![codecov](https://codecov.io/gh/pusher/pusher-websocket-swift/branch/master/graph/badge.svg)](https://codecov.io/gh/pusher/pusher-websocket-swift)
1111

1212
This is the [Pusher Channels](https://pusher.com/channels) websocket client, PusherSwift, which supports iOS, macOS (OS X) and tvOS. It works with Swift and Objective-C.
1313

‎Scripts/generate-api-docs.sh

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
#! /bin/sh
2+
3+
set -e
4+
5+
if ! which jazzy >/dev/null; then
6+
echo "Error: Jazzy not installed, see https://github.com/realm/Jazzy or run 'gem install jazzy' to install it"
7+
exit 1
8+
fi
9+
10+
if ! which jq >/dev/null; then
11+
echo "Error: jq not installed, run 'brew install jq' to install it"
12+
exit 1
13+
fi
14+
15+
read -p 'Enter release tag (without quotes): ' RELEASE_TAG
16+
17+
AUTHOR_NAME="Pusher Limited"
18+
AUTHOR_URL="https://pusher.com"
19+
GITHUB_ORIGIN=$(git remote get-url origin)
20+
GITHUB_URL=${GITHUB_ORIGIN%".git"}
21+
MODULE_NAME=$(swift package dump-package | jq --raw-output '.name')
22+
23+
echo "Generating public API docs from release tag $RELEASE_TAG"
24+
25+
# The 'arch -x86_64' command is redundant on Intel Macs, and runs Jazzy under Rosetta 2 on Apple Silicon Macs for compatibility
26+
arch -x86_64 jazzy \
27+
--module $MODULE_NAME \
28+
--module_version $RELEASE_TAG \
29+
--swift-build-tool spm \
30+
--author $AUTHOR_NAME \
31+
--author_url $AUTHOR_URL \
32+
--github_url $GITHUB_URL \
33+
--github-file-prefix $GITHUB_URL/tree/$RELEASE_TAG

‎docs/Classes.html

Lines changed: 583 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/Classes/GlobalChannel.html

Lines changed: 259 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,259 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<title>GlobalChannel Class Reference</title>
5+
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
6+
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
7+
<meta charset='utf-8'>
8+
<script src="../js/jquery.min.js" defer></script>
9+
<script src="../js/jazzy.js" defer></script>
10+
11+
<script src="../js/lunr.min.js" defer></script>
12+
<script src="../js/typeahead.jquery.js" defer></script>
13+
<script src="../js/jazzy.search.js" defer></script>
14+
</head>
15+
<body>
16+
<a name="//apple_ref/swift/Class/GlobalChannel" class="dashAnchor"></a>
17+
<a title="GlobalChannel Class Reference"></a>
18+
<header>
19+
<div class="content-wrapper">
20+
<p><a href="../index.html">PusherSwift 9.2.2 Docs</a> (25% documented)</p>
21+
<p class="header-right"><a href="https://github.com/pusher/pusher-websocket-swift"><img src="../img/gh.png"/>View on GitHub</a></p>
22+
<p class="header-right">
23+
<form role="search" action="../search.json">
24+
<input type="text" placeholder="Search documentation" data-typeahead>
25+
</form>
26+
</p>
27+
</div>
28+
</header>
29+
<div class="content-wrapper">
30+
<p id="breadcrumbs">
31+
<a href="../index.html">PusherSwift Reference</a>
32+
<img id="carat" src="../img/carat.png" />
33+
GlobalChannel Class Reference
34+
</p>
35+
</div>
36+
<div class="content-wrapper">
37+
<nav class="sidebar">
38+
<ul class="nav-groups">
39+
<li class="nav-group-name">
40+
<a href="../Classes.html">Classes</a>
41+
<ul class="nav-group-tasks">
42+
<li class="nav-group-task">
43+
<a href="../Classes/GlobalChannel.html">GlobalChannel</a>
44+
</li>
45+
<li class="nav-group-task">
46+
<a href="../Classes/OCAuthMethod.html">OCAuthMethod</a>
47+
</li>
48+
<li class="nav-group-task">
49+
<a href="../Classes/OCPusherHost.html">OCPusherHost</a>
50+
</li>
51+
<li class="nav-group-task">
52+
<a href="../Classes/Pusher.html">Pusher</a>
53+
</li>
54+
<li class="nav-group-task">
55+
<a href="../Classes/PusherAuth.html">PusherAuth</a>
56+
</li>
57+
<li class="nav-group-task">
58+
<a href="../Classes/PusherChannel.html">PusherChannel</a>
59+
</li>
60+
<li class="nav-group-task">
61+
<a href="../Classes/PusherChannels.html">PusherChannels</a>
62+
</li>
63+
<li class="nav-group-task">
64+
<a href="../Classes/PusherClientOptions.html">PusherClientOptions</a>
65+
</li>
66+
<li class="nav-group-task">
67+
<a href="../Classes/PusherConnection.html">PusherConnection</a>
68+
</li>
69+
<li class="nav-group-task">
70+
<a href="../Classes/PusherError.html">PusherError</a>
71+
</li>
72+
<li class="nav-group-task">
73+
<a href="../Classes/PusherEvent.html">PusherEvent</a>
74+
</li>
75+
<li class="nav-group-task">
76+
<a href="../Classes/PusherPresenceChannel.html">PusherPresenceChannel</a>
77+
</li>
78+
<li class="nav-group-task">
79+
<a href="../Classes/PusherPresenceChannelMember.html">PusherPresenceChannelMember</a>
80+
</li>
81+
</ul>
82+
</li>
83+
<li class="nav-group-name">
84+
<a href="../Enums.html">Enumerations</a>
85+
<ul class="nav-group-tasks">
86+
<li class="nav-group-task">
87+
<a href="../Enums/AuthMethod.html">AuthMethod</a>
88+
</li>
89+
<li class="nav-group-task">
90+
<a href="../Enums/ConnectionState.html">ConnectionState</a>
91+
</li>
92+
<li class="nav-group-task">
93+
<a href="../Enums/PusherChannelType.html">PusherChannelType</a>
94+
</li>
95+
<li class="nav-group-task">
96+
<a href="../Enums/PusherHost.html">PusherHost</a>
97+
</li>
98+
</ul>
99+
</li>
100+
<li class="nav-group-name">
101+
<a href="../Protocols.html">Protocols</a>
102+
<ul class="nav-group-tasks">
103+
<li class="nav-group-task">
104+
<a href="../Protocols/AuthRequestBuilderProtocol.html">AuthRequestBuilderProtocol</a>
105+
</li>
106+
<li class="nav-group-task">
107+
<a href="../Protocols/Authorizer.html">Authorizer</a>
108+
</li>
109+
<li class="nav-group-task">
110+
<a href="../Protocols/PusherDelegate.html">PusherDelegate</a>
111+
</li>
112+
</ul>
113+
</li>
114+
<li class="nav-group-name">
115+
<a href="../Structs.html">Structures</a>
116+
<ul class="nav-group-tasks">
117+
<li class="nav-group-task">
118+
<a href="../Structs.html#/s:11PusherSwift12EventHandlerV">EventHandler</a>
119+
</li>
120+
<li class="nav-group-task">
121+
<a href="../Structs/QueuedClientEvent.html">QueuedClientEvent</a>
122+
</li>
123+
</ul>
124+
</li>
125+
<li class="nav-group-name">
126+
<a href="../Typealiases.html">Type Aliases</a>
127+
<ul class="nav-group-tasks">
128+
<li class="nav-group-task">
129+
<a href="../Typealiases.html#/s:11PusherSwift0A14UserInfoObjecta">PusherUserInfoObject</a>
130+
</li>
131+
</ul>
132+
</li>
133+
</ul>
134+
</nav>
135+
<article class="main-content">
136+
<section>
137+
<section class="section">
138+
<h1>GlobalChannel</h1>
139+
<div class="declaration">
140+
<div class="language">
141+
142+
<pre class="highlight swift"><code><span class="kd">@objcMembers</span>
143+
<span class="kd">@objc</span>
144+
<span class="kd">open</span> <span class="kd">class</span> <span class="kt">GlobalChannel</span> <span class="p">:</span> <span class="kt"><a href="../Classes/PusherChannel.html">PusherChannel</a></span></code></pre>
145+
146+
</div>
147+
</div>
148+
<p>Undocumented</p>
149+
150+
<div class="slightly-smaller">
151+
<a href="https://github.com/pusher/pusher-websocket-swift/tree/9.2.2/Sources/Models/PusherGlobalChannel.swift#L4-L85">Show on GitHub</a>
152+
</div>
153+
</section>
154+
<section class="section task-group-section">
155+
<div class="task-group">
156+
<ul>
157+
<li class="item">
158+
<div>
159+
<code>
160+
<a name="/s:11PusherSwift13GlobalChannelC15globalCallbacksSDySSyAA0A5EventCcGvp"></a>
161+
<a name="//apple_ref/swift/Property/globalCallbacks" class="dashAnchor"></a>
162+
<a class="token" href="#/s:11PusherSwift13GlobalChannelC15globalCallbacksSDySSyAA0A5EventCcGvp">globalCallbacks</a>
163+
</code>
164+
</div>
165+
<div class="height-container">
166+
<div class="pointer-container"></div>
167+
<section class="section">
168+
<div class="pointer"></div>
169+
<div class="abstract">
170+
<p>Undocumented</p>
171+
172+
</div>
173+
<div class="declaration">
174+
<h4>Declaration</h4>
175+
<div class="language">
176+
<p class="aside-title">Swift</p>
177+
<pre class="highlight swift"><code><span class="kd">open</span> <span class="k">var</span> <span class="nv">globalCallbacks</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="p">(</span><span class="kt"><a href="../Classes/PusherEvent.html">PusherEvent</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">]</span></code></pre>
178+
179+
</div>
180+
</div>
181+
<div class="slightly-smaller">
182+
<a href="https://github.com/pusher/pusher-websocket-swift/tree/9.2.2/Sources/Models/PusherGlobalChannel.swift#L">Show on GitHub</a>
183+
</div>
184+
</section>
185+
</div>
186+
</li>
187+
<li class="item">
188+
<div>
189+
<code>
190+
<a name="/s:11PusherSwift13GlobalChannelC21globalLegacyCallbacksSDySSyypSgcGvp"></a>
191+
<a name="//apple_ref/swift/Property/globalLegacyCallbacks" class="dashAnchor"></a>
192+
<a class="token" href="#/s:11PusherSwift13GlobalChannelC21globalLegacyCallbacksSDySSyypSgcGvp">globalLegacyCallbacks</a>
193+
</code>
194+
</div>
195+
<div class="height-container">
196+
<div class="pointer-container"></div>
197+
<section class="section">
198+
<div class="pointer"></div>
199+
<div class="abstract">
200+
<p>Undocumented</p>
201+
202+
</div>
203+
<div class="declaration">
204+
<h4>Declaration</h4>
205+
<div class="language">
206+
<p class="aside-title">Swift</p>
207+
<pre class="highlight swift"><code><span class="kd">open</span> <span class="k">var</span> <span class="nv">globalLegacyCallbacks</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="p">(</span><span class="kt">Any</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt">Void</span><span class="p">]</span></code></pre>
208+
209+
</div>
210+
</div>
211+
<div class="slightly-smaller">
212+
<a href="https://github.com/pusher/pusher-websocket-swift/tree/9.2.2/Sources/Models/PusherGlobalChannel.swift#L">Show on GitHub</a>
213+
</div>
214+
</section>
215+
</div>
216+
</li>
217+
<li class="item">
218+
<div>
219+
<code>
220+
<a name="/c:@M@PusherSwift@objc(cs)GlobalChannel(im)unbindAll"></a>
221+
<a name="//apple_ref/swift/Method/unbindAll()" class="dashAnchor"></a>
222+
<a class="token" href="#/c:@M@PusherSwift@objc(cs)GlobalChannel(im)unbindAll">unbindAll()</a>
223+
</code>
224+
</div>
225+
<div class="height-container">
226+
<div class="pointer-container"></div>
227+
<section class="section">
228+
<div class="pointer"></div>
229+
<div class="abstract">
230+
<p>Unbinds all callbacks from the channel</p>
231+
232+
</div>
233+
<div class="declaration">
234+
<h4>Declaration</h4>
235+
<div class="language">
236+
<p class="aside-title">Swift</p>
237+
<pre class="highlight swift"><code><span class="k">override</span> <span class="kd">open</span> <span class="kd">func</span> <span class="nf">unbindAll</span><span class="p">()</span></code></pre>
238+
239+
</div>
240+
</div>
241+
<div class="slightly-smaller">
242+
<a href="https://github.com/pusher/pusher-websocket-swift/tree/9.2.2/Sources/Models/PusherGlobalChannel.swift#L81-L84">Show on GitHub</a>
243+
</div>
244+
</section>
245+
</div>
246+
</li>
247+
</ul>
248+
</div>
249+
</section>
250+
</section>
251+
<section id="footer">
252+
<p>&copy; 2021 <a class="link" href="https://pusher.com" target="_blank" rel="external">Pusher</a>. All rights reserved. (Last updated: 2021-07-07)</p>
253+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
254+
</section>
255+
</article>
256+
</div>
257+
</body>
258+
</div>
259+
</html>

0 commit comments

Comments
 (0)