Update docs

mixpanel · Aug 16, 2022 · 4a2341c · 4a2341c
1 parent c47fcbf
commit 4a2341c
Show file tree

Hide file tree

Showing 21 changed files with 6,568 additions and 0 deletions.
diff --git a/docs/Classes/Mixpanel.html b/docs/Classes/Mixpanel.html
diff --git a/docs/Classes/MixpanelGroup.html b/docs/Classes/MixpanelGroup.html
diff --git a/docs/Classes/MixpanelPeople.html b/docs/Classes/MixpanelPeople.html
diff --git a/docs/Protocols/MixpanelDelegate.html b/docs/Protocols/MixpanelDelegate.html
@@ -0,0 +1,207 @@
+<!DOCTYPE html>
+<html>
+<head>
+	<meta charset="utf-8">
+
+	<title>MixpanelDelegate Protocol Reference</title>
+
+	<link rel="stylesheet" href="../css/style.css">
+	<meta name="viewport" content="initial-scale=1, maximum-scale=1.4">
+	<meta name="generator" content="appledoc 2.2.1 (build 1334)">
+</head>
+<body class="appledoc">
+	<header>
+		<div class="container" class="hide-in-xcode">
+
+			<h1 id="library-title">
+				<a href="../index.html">mixpanel-iphone </a>
+			</h1>
+
+			<p id="developer-home">
+				<a href="../index.html">Mixpanel</a>
+			</p>
+
+		</div>
+	</header>
+
+	<aside>
+		<div class="container">
+			<nav>
+				<ul id="header-buttons" role="toolbar">
+					<li><a href="../index.html">Index</a></li>
+<li><a href="../hierarchy.html">Hierarchy</a></li>
+
+					<li id="on-this-page" role="navigation">
+						<label>
+							On This Page
+
+							<div class="chevron">
+								<div class="chevy chevron-left"></div>
+								<div class="chevy chevron-right"></div>
+							</div>
+
+							<select id="jump-to">
+	<option value="top">Jump To&#133;</option>
+
+	<option value="overview">Overview</option>
+
+
+
+
+	<option value="tasks">Tasks</option>
+
+
+
+
+
+
+
+
+
+	<optgroup label="Instance Methods">
+
+		<option value="//api/name/mixpanelWillFlush:">- mixpanelWillFlush:</option>
+
+	</optgroup>
+
+
+</select>
+						</label>
+					</li>
+				</ul>
+			</nav>
+		</div>
+	</aside>
+
+	<article>
+		<div id="overview_contents" class="container">
+			<div id="content">
+				<main role="main">
+					<h1 class="title">MixpanelDelegate Protocol Reference</h1>
+
+
+					<div class="section section-specification"><table cellspacing="0"><tbody>
+						<tr>
+	<th>Conforms to</th>
+	<td>NSObject</td>
+</tr><tr>
+	<th>Declared in</th>
+	<td>Mixpanel.h</td>
+</tr>
+						</tbody></table></div>
+
+
+
+
+					<div class="section section-overview">
+						<a title="Overview" name="overview"></a>
+						<h2 class="subtitle subtitle-overview">Overview</h2>
+						<p>@protocol</p>
+
+<p>Delegate protocol for controlling the <a href="../Classes/Mixpanel.html">Mixpanel</a> API&rsquo;s network behavior.</p>
+
+<p>Creating a delegate for the <a href="../Classes/Mixpanel.html">Mixpanel</a> object is entirely optional. It is only
+necessary when you want full control over when data is uploaded to the server,
+beyond simply calling stop: and start: before and after a particular block of
+your code.</p>
+					</div>
+
+
+
+
+
+					<div class="section section-tasks">
+						<a title="Tasks" name="tasks"></a>
+
+
+
+
+
+						<div class="task-list">
+							<div class="section-method">
+	<a name="//api/name/mixpanelWillFlush:" title="mixpanelWillFlush:"></a>
+	<h3 class="method-title"><code><a href="#//api/name/mixpanelWillFlush:">&ndash;&nbsp;mixpanelWillFlush:</a></code>
+</h3>
+
+	<div class="method-info">
+		<div class="pointy-thing"></div>
+
+		<div class="method-info-container">
+
+
+			<div class="method-subsection brief-description">
+				<p>Asks the delegate if data should be uploaded to the server.</p>
+			</div>
+
+
+
+			<div class="method-subsection method-declaration"><code>- (BOOL)mixpanelWillFlush:(Mixpanel *)<em>mixpanel</em></code></div>
+
+
+
+			<div class="method-subsection arguments-section parameters">
+				<h4 class="method-subtitle parameter-title">Parameters</h4>
+				<table class="argument-def parameter-def">
+
+					<tr>
+						<th scope="row" class="argument-name"><code>mixpanel</code></th>
+						<td><p><a href="../Classes/Mixpanel.html">Mixpanel</a> API instance</p></td>
+					</tr>
+
+				</table>
+			</div>
+
+
+
+
+
+
+
+			<div class="method-subsection discussion-section">
+				<h4 class="method-subtitle">Discussion</h4>
+				<p>Return YES to upload now, NO to defer until later.</p>
+			</div>
+
+
+
+
+
+
+
+			<div class="method-subsection declared-in-section">
+				<h4 class="method-subtitle">Declared In</h4>
+				<p><code class="declared-in-ref">Mixpanel.h</code></p>
+			</div>
+
+
+		</div>
+	</div>
+</div>
+						</div>
+
+					</div>
+
+
+
+
+
+
+				</main>
+
+				<footer>
+					<div class="footer-copyright">
+
+						<p class="copyright">Copyright &copy; 2022 Mixpanel. All rights reserved. Updated: 2022-08-16</p>
+
+
+						<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p>
+
+					</div>
+				</footer>
+			</div>
+		</div>
+	</article>
+
+	<script src="../js/script.js"></script>
+</body>
+</html>
diff --git a/docs/css/scss/_index.scss b/docs/css/scss/_index.scss
@@ -0,0 +1,17 @@
+.index-container {
+	-webkit-flex-direction: column;
+	flex-direction: column;
+
+	@media (min-width: $desktop-min-width) {
+		display: flex;
+		-webkit-flex-direction: row;
+		flex-direction: row;
+		-webkit-flex-wrap: wrap;
+		flex-wrap: wrap;
+	}
+
+	.index-column {
+		-webkit-flex: 1 1 33%;
+		flex: 1 1 33%;
+	}
+}