Skip to content

Commit 6a19cda

Browse files
conquerorconqueror
committed
Jazzy generated docs
1 parent 26a3503 commit 6a19cda

44 files changed

Lines changed: 6722 additions & 0 deletions

Some content is hidden

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

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Using Swift Package Manager, add the following to your packages.swift
1111
Run `swift package update` and if you use Xcode run `swift package generate-xcodeproj`
1212
## Usage
1313
Create a file that includes the configuration for your application, for instance:
14+
1415
{
1516
"server": {
1617
"baseURL": "localhost:8181",
@@ -41,6 +42,7 @@ Create a file that includes the configuration for your application, for instance
4142
}
4243

4344
Then modify your main.swift:
45+
4446
import ApplicationConfiguration
4547

4648
#if os(Linux)

‎docs/Enums.html‎

Lines changed: 187 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,187 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<title>Enumerations 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+
</head>
12+
<body>
13+
<a name="//apple_ref/swift/Section/Enumerations" class="dashAnchor"></a>
14+
<a title="Enumerations Reference"></a>
15+
<header>
16+
<div class="content-wrapper">
17+
<p><a href="index.html"> Docs</a> (100% documented)</p>
18+
<p class="header-right"><a href="https://github.com/PerfectAccelerators/ApplicationConfiguration"><img src="img/gh.png"/>View on GitHub</a></p>
19+
</div>
20+
</header>
21+
<div class="content-wrapper">
22+
<p id="breadcrumbs">
23+
<a href="index.html"> Reference</a>
24+
<img id="carat" src="img/carat.png" />
25+
Enumerations Reference
26+
</p>
27+
</div>
28+
<div class="content-wrapper">
29+
<nav class="sidebar">
30+
<ul class="nav-groups">
31+
<li class="nav-group-name">
32+
<a href="Enums.html">Enumerations</a>
33+
<ul class="nav-group-tasks">
34+
<li class="nav-group-task">
35+
<a href="Enums/DBDriverType.html">DBDriverType</a>
36+
</li>
37+
<li class="nav-group-task">
38+
<a href="Enums/Environment.html">Environment</a>
39+
</li>
40+
<li class="nav-group-task">
41+
<a href="Enums/OS.html">OS</a>
42+
</li>
43+
</ul>
44+
</li>
45+
<li class="nav-group-name">
46+
<a href="Protocols.html">Protocols</a>
47+
<ul class="nav-group-tasks">
48+
<li class="nav-group-task">
49+
<a href="Protocols/AppProtocol.html">AppProtocol</a>
50+
</li>
51+
</ul>
52+
</li>
53+
<li class="nav-group-name">
54+
<a href="Structs.html">Structures</a>
55+
<ul class="nav-group-tasks">
56+
<li class="nav-group-task">
57+
<a href="Structs.html#/s:24ApplicationConfiguration10AppFiltersV">AppFilters</a>
58+
</li>
59+
<li class="nav-group-task">
60+
<a href="Structs/Application.html">Application</a>
61+
</li>
62+
<li class="nav-group-task">
63+
<a href="Structs/Configuration.html">Configuration</a>
64+
</li>
65+
<li class="nav-group-task">
66+
<a href="Structs/DBConfiguration.html">DBConfiguration</a>
67+
</li>
68+
<li class="nav-group-task">
69+
<a href="Structs.html#/s:24ApplicationConfiguration07LoggingB0V">LoggingConfiguration</a>
70+
</li>
71+
<li class="nav-group-task">
72+
<a href="Structs.html#/s:24ApplicationConfiguration16SSLConfigurationV">SSLConfiguration</a>
73+
</li>
74+
<li class="nav-group-task">
75+
<a href="Structs.html#/s:24ApplicationConfiguration06ServerB0V">ServerConfiguration</a>
76+
</li>
77+
</ul>
78+
</li>
79+
</ul>
80+
</nav>
81+
<article class="main-content">
82+
<section>
83+
<section class="section">
84+
<h1>Enumerations</h1>
85+
<p>The following enumerations are available globally.</p>
86+
87+
</section>
88+
<section class="section task-group-section">
89+
<div class="task-group">
90+
<ul>
91+
<li class="item">
92+
<div>
93+
<code>
94+
<a name="/s:24ApplicationConfiguration12DBDriverTypeO"></a>
95+
<a name="//apple_ref/swift/Enum/DBDriverType" class="dashAnchor"></a>
96+
<a class="token" href="#/s:24ApplicationConfiguration12DBDriverTypeO">DBDriverType</a>
97+
</code>
98+
</div>
99+
<div class="height-container">
100+
<div class="pointer-container"></div>
101+
<section class="section">
102+
<div class="pointer"></div>
103+
<div class="abstract">
104+
<p>Database driver type</p>
105+
106+
<a href="Enums/DBDriverType.html" class="slightly-smaller">See more</a>
107+
</div>
108+
<div class="declaration">
109+
<h4>Declaration</h4>
110+
<div class="language">
111+
<p class="aside-title">Swift</p>
112+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">DBDriverType</span> <span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="kt">Codable</span></code></pre>
113+
114+
</div>
115+
</div>
116+
</section>
117+
</div>
118+
</li>
119+
<li class="item">
120+
<div>
121+
<code>
122+
<a name="/s:24ApplicationConfiguration2OSO"></a>
123+
<a name="//apple_ref/swift/Enum/OS" class="dashAnchor"></a>
124+
<a class="token" href="#/s:24ApplicationConfiguration2OSO">OS</a>
125+
</code>
126+
</div>
127+
<div class="height-container">
128+
<div class="pointer-container"></div>
129+
<section class="section">
130+
<div class="pointer"></div>
131+
<div class="abstract">
132+
<p>operating system</p>
133+
134+
<a href="Enums/OS.html" class="slightly-smaller">See more</a>
135+
</div>
136+
<div class="declaration">
137+
<h4>Declaration</h4>
138+
<div class="language">
139+
<p class="aside-title">Swift</p>
140+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">OS</span> <span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="kt">Codable</span></code></pre>
141+
142+
</div>
143+
</div>
144+
</section>
145+
</div>
146+
</li>
147+
<li class="item">
148+
<div>
149+
<code>
150+
<a name="/s:24ApplicationConfiguration11EnvironmentO"></a>
151+
<a name="//apple_ref/swift/Enum/Environment" class="dashAnchor"></a>
152+
<a class="token" href="#/s:24ApplicationConfiguration11EnvironmentO">Environment</a>
153+
</code>
154+
</div>
155+
<div class="height-container">
156+
<div class="pointer-container"></div>
157+
<section class="section">
158+
<div class="pointer"></div>
159+
<div class="abstract">
160+
<p>deployment environment</p>
161+
162+
<a href="Enums/Environment.html" class="slightly-smaller">See more</a>
163+
</div>
164+
<div class="declaration">
165+
<h4>Declaration</h4>
166+
<div class="language">
167+
<p class="aside-title">Swift</p>
168+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">Environment</span> <span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="kt">Codable</span></code></pre>
169+
170+
</div>
171+
</div>
172+
</section>
173+
</div>
174+
</li>
175+
</ul>
176+
</div>
177+
</section>
178+
</section>
179+
<section id="footer">
180+
<p>&copy; 2018 <a class="link" href="https://github.com/PerfectAccelerators" target="_blank" rel="external">PerfectAccelerators</a>. All rights reserved. (Last updated: 2018-05-17)</p>
181+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
182+
</section>
183+
</article>
184+
</div>
185+
</body>
186+
</div>
187+
</html>

‎docs/Enums/DBDriverType.html‎

Lines changed: 190 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<title>DBDriverType Enumeration 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+
</head>
12+
<body>
13+
<a name="//apple_ref/swift/Enum/DBDriverType" class="dashAnchor"></a>
14+
<a title="DBDriverType Enumeration Reference"></a>
15+
<header>
16+
<div class="content-wrapper">
17+
<p><a href="../index.html"> Docs</a> (100% documented)</p>
18+
<p class="header-right"><a href="https://github.com/PerfectAccelerators/ApplicationConfiguration"><img src="../img/gh.png"/>View on GitHub</a></p>
19+
</div>
20+
</header>
21+
<div class="content-wrapper">
22+
<p id="breadcrumbs">
23+
<a href="../index.html"> Reference</a>
24+
<img id="carat" src="../img/carat.png" />
25+
DBDriverType Enumeration Reference
26+
</p>
27+
</div>
28+
<div class="content-wrapper">
29+
<nav class="sidebar">
30+
<ul class="nav-groups">
31+
<li class="nav-group-name">
32+
<a href="../Enums.html">Enumerations</a>
33+
<ul class="nav-group-tasks">
34+
<li class="nav-group-task">
35+
<a href="../Enums/DBDriverType.html">DBDriverType</a>
36+
</li>
37+
<li class="nav-group-task">
38+
<a href="../Enums/Environment.html">Environment</a>
39+
</li>
40+
<li class="nav-group-task">
41+
<a href="../Enums/OS.html">OS</a>
42+
</li>
43+
</ul>
44+
</li>
45+
<li class="nav-group-name">
46+
<a href="../Protocols.html">Protocols</a>
47+
<ul class="nav-group-tasks">
48+
<li class="nav-group-task">
49+
<a href="../Protocols/AppProtocol.html">AppProtocol</a>
50+
</li>
51+
</ul>
52+
</li>
53+
<li class="nav-group-name">
54+
<a href="../Structs.html">Structures</a>
55+
<ul class="nav-group-tasks">
56+
<li class="nav-group-task">
57+
<a href="../Structs.html#/s:24ApplicationConfiguration10AppFiltersV">AppFilters</a>
58+
</li>
59+
<li class="nav-group-task">
60+
<a href="../Structs/Application.html">Application</a>
61+
</li>
62+
<li class="nav-group-task">
63+
<a href="../Structs/Configuration.html">Configuration</a>
64+
</li>
65+
<li class="nav-group-task">
66+
<a href="../Structs/DBConfiguration.html">DBConfiguration</a>
67+
</li>
68+
<li class="nav-group-task">
69+
<a href="../Structs.html#/s:24ApplicationConfiguration07LoggingB0V">LoggingConfiguration</a>
70+
</li>
71+
<li class="nav-group-task">
72+
<a href="../Structs.html#/s:24ApplicationConfiguration16SSLConfigurationV">SSLConfiguration</a>
73+
</li>
74+
<li class="nav-group-task">
75+
<a href="../Structs.html#/s:24ApplicationConfiguration06ServerB0V">ServerConfiguration</a>
76+
</li>
77+
</ul>
78+
</li>
79+
</ul>
80+
</nav>
81+
<article class="main-content">
82+
<section>
83+
<section class="section">
84+
<h1>DBDriverType</h1>
85+
<div class="declaration">
86+
<div class="language">
87+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">DBDriverType</span> <span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="kt">Codable</span></code></pre>
88+
89+
</div>
90+
</div>
91+
<p>Database driver type</p>
92+
93+
</section>
94+
<section class="section task-group-section">
95+
<div class="task-group">
96+
<ul>
97+
<li class="item">
98+
<div>
99+
<code>
100+
<a name="/s:24ApplicationConfiguration12DBDriverTypeO5mySQLA2CmF"></a>
101+
<a name="//apple_ref/swift/Element/mySQL" class="dashAnchor"></a>
102+
<a class="token" href="#/s:24ApplicationConfiguration12DBDriverTypeO5mySQLA2CmF">mySQL</a>
103+
</code>
104+
</div>
105+
<div class="height-container">
106+
<div class="pointer-container"></div>
107+
<section class="section">
108+
<div class="pointer"></div>
109+
<div class="abstract">
110+
<p>MySQL</p>
111+
112+
</div>
113+
<div class="declaration">
114+
<h4>Declaration</h4>
115+
<div class="language">
116+
<p class="aside-title">Swift</p>
117+
<pre class="highlight swift"><code><span class="k">case</span> <span class="n">mySQL</span> <span class="o">=</span> <span class="mi">1</span></code></pre>
118+
119+
</div>
120+
</div>
121+
</section>
122+
</div>
123+
</li>
124+
<li class="item">
125+
<div>
126+
<code>
127+
<a name="/s:24ApplicationConfiguration12DBDriverTypeO10postgreSQLA2CmF"></a>
128+
<a name="//apple_ref/swift/Element/postgreSQL" class="dashAnchor"></a>
129+
<a class="token" href="#/s:24ApplicationConfiguration12DBDriverTypeO10postgreSQLA2CmF">postgreSQL</a>
130+
</code>
131+
</div>
132+
<div class="height-container">
133+
<div class="pointer-container"></div>
134+
<section class="section">
135+
<div class="pointer"></div>
136+
<div class="abstract">
137+
<p>PostgreSQL</p>
138+
139+
</div>
140+
<div class="declaration">
141+
<h4>Declaration</h4>
142+
<div class="language">
143+
<p class="aside-title">Swift</p>
144+
<pre class="highlight swift"><code><span class="k">case</span> <span class="n">postgreSQL</span> <span class="o">=</span> <span class="mi">2</span></code></pre>
145+
146+
</div>
147+
</div>
148+
</section>
149+
</div>
150+
</li>
151+
<li class="item">
152+
<div>
153+
<code>
154+
<a name="/s:24ApplicationConfiguration12DBDriverTypeO6sqLiteA2CmF"></a>
155+
<a name="//apple_ref/swift/Element/sqLite" class="dashAnchor"></a>
156+
<a class="token" href="#/s:24ApplicationConfiguration12DBDriverTypeO6sqLiteA2CmF">sqLite</a>
157+
</code>
158+
</div>
159+
<div class="height-container">
160+
<div class="pointer-container"></div>
161+
<section class="section">
162+
<div class="pointer"></div>
163+
<div class="abstract">
164+
<p>SQLite</p>
165+
166+
</div>
167+
<div class="declaration">
168+
<h4>Declaration</h4>
169+
<div class="language">
170+
<p class="aside-title">Swift</p>
171+
<pre class="highlight swift"><code><span class="k">case</span> <span class="n">sqLite</span> <span class="o">=</span> <span class="mi">3</span></code></pre>
172+
173+
</div>
174+
</div>
175+
</section>
176+
</div>
177+
</li>
178+
</ul>
179+
</div>
180+
</section>
181+
</section>
182+
<section id="footer">
183+
<p>&copy; 2018 <a class="link" href="https://github.com/PerfectAccelerators" target="_blank" rel="external">PerfectAccelerators</a>. All rights reserved. (Last updated: 2018-05-17)</p>
184+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
185+
</section>
186+
</article>
187+
</div>
188+
</body>
189+
</div>
190+
</html>

0 commit comments

Comments
 (0)