Skip to content
This repository has been archived by the owner on Aug 24, 2019. It is now read-only.

Commit

Permalink
Add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
soffes committed Mar 20, 2017
1 parent e1bc8d8 commit acb1d10
Show file tree
Hide file tree
Showing 33 changed files with 3,129 additions and 0 deletions.
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
.DS_Store
*xcuserdata/
*.mode1v3
*.pbxuser
*.xcworkspace
build
13 changes: 13 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
desc 'Generate documentation'
task :docs do
sh 'rm -rf docs'
sh 'jazzy \
--clean \
--author "Sam Soffes" \
--author_url https://soff.es \
--github_url https://github.com/soffes/SharedWebCredentials \
--github-file-prefix https://github.com/soffes/SharedWebCredentials/tree/`git describe --tags --abbrev=0` \
--root-url https://soffes.github.io/SharedWebCredentials/ \
--output docs/'
sh 'rm -rf build'
end
135 changes: 135 additions & 0 deletions docs/Structs.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Structs Reference</title>
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
<meta charset='utf-8'>
<script src="js/jquery.min.js" defer></script>
<script src="js/jazzy.js" defer></script>

</head>
<body>
<a title="Structs Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html"> Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/soffes/SharedWebCredentials"><img src="img/gh.png"/>View on GitHub</a></p>
<p class="header-right"><a href="dash-feed://https%3A%2F%2Fsoffes%2Egithub%2Eio%2FSharedWebCredentials%2Fdocsets%2F%2Exml"><img src="img/dash.png"/>Install in Dash</a></p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="index.html"> Reference</a>
<img id="carat" src="img/carat.png" />
Structs Reference
</p>
</div>
<div class="content-wrapper">
<nav class="sidebar">
<ul class="nav-groups">
<li class="nav-group-name">
<a href="Structs.html">Structs</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Structs/Credential.html">Credential</a>
</li>
<li class="nav-group-task">
<a href="Structs/Store.html">Store</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>Structs</h1>
<p>The following structs are available globally.</p>

</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:V20SharedWebCredentials10Credential"></a>
<a name="//apple_ref/swift/Struct/Credential" class="dashAnchor"></a>
<a class="token" href="#/s:V20SharedWebCredentials10Credential">Credential</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Single credential from Shared Web Credentials Store.</p>

<a href="Structs/Credential.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">Credential</span></code></pre>

</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/soffes/SharedWebCredentials/tree/v0.1.0/SharedWebCredentials/Sources/Credential.swift#L10-L34">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:V20SharedWebCredentials5Store"></a>
<a name="//apple_ref/swift/Struct/Store" class="dashAnchor"></a>
<a class="token" href="#/s:V20SharedWebCredentials5Store">Store</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Shared Web Credentials Store.</p>

<p>Supports reading, adding, and removing shared web credentials. There is also a utility method for generating a new
password.</p>

<a href="Structs/Store.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">Store</span></code></pre>

</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/soffes/SharedWebCredentials/tree/v0.1.0/SharedWebCredentials/Sources/Store.swift#L17-L164">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2017 <a class="link" href="https://soff.es" target="_blank" rel="external">Sam Soffes</a>. All rights reserved. (Last updated: 2017-03-20)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>
163 changes: 163 additions & 0 deletions docs/Structs/Credential.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Credential Struct Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset='utf-8'>
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>

</head>
<body>
<a name="//apple_ref/swift/Struct/Credential" class="dashAnchor"></a>
<a title="Credential Struct Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/soffes/SharedWebCredentials"><img src="../img/gh.png"/>View on GitHub</a></p>
<p class="header-right"><a href="dash-feed://https%3A%2F%2Fsoffes%2Egithub%2Eio%2FSharedWebCredentials%2Fdocsets%2F%2Exml"><img src="../img/dash.png"/>Install in Dash</a></p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html"> Reference</a>
<img id="carat" src="../img/carat.png" />
Credential Struct Reference
</p>
</div>
<div class="content-wrapper">
<nav class="sidebar">
<ul class="nav-groups">
<li class="nav-group-name">
<a href="../Structs.html">Structs</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Structs/Credential.html">Credential</a>
</li>
<li class="nav-group-task">
<a href="../Structs/Store.html">Store</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>Credential</h1>
<div class="declaration">
<div class="language">
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">Credential</span></code></pre>

</div>
</div>
<p>Single credential from Shared Web Credentials Store.</p>

</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:vV20SharedWebCredentials10Credential6domainSS"></a>
<a name="//apple_ref/swift/Property/domain" class="dashAnchor"></a>
<a class="token" href="#/s:vV20SharedWebCredentials10Credential6domainSS">domain</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Fully qualified domain name of the website</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">domain</span><span class="p">:</span> <span class="kt">String</span></code></pre>

</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/soffes/SharedWebCredentials/tree/v0.1.0/SharedWebCredentials/Sources/Credential.swift#L13">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vV20SharedWebCredentials10Credential7accountSS"></a>
<a name="//apple_ref/swift/Property/account" class="dashAnchor"></a>
<a class="token" href="#/s:vV20SharedWebCredentials10Credential7accountSS">account</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Account name</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">account</span><span class="p">:</span> <span class="kt">String</span></code></pre>

</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/soffes/SharedWebCredentials/tree/v0.1.0/SharedWebCredentials/Sources/Credential.swift#L16">Show on GitHub</a>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vV20SharedWebCredentials10Credential8passwordSS"></a>
<a name="//apple_ref/swift/Property/password" class="dashAnchor"></a>
<a class="token" href="#/s:vV20SharedWebCredentials10Credential8passwordSS">password</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Password</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">let</span> <span class="nv">password</span><span class="p">:</span> <span class="kt">String</span></code></pre>

</div>
</div>
<div class="slightly-smaller">
<a href="https://github.com/soffes/SharedWebCredentials/tree/v0.1.0/SharedWebCredentials/Sources/Credential.swift#L19">Show on GitHub</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2017 <a class="link" href="https://soff.es" target="_blank" rel="external">Sam Soffes</a>. All rights reserved. (Last updated: 2017-03-20)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.4</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>
Loading

0 comments on commit acb1d10

Please sign in to comment.