Skip to content

Commit

Permalink
Improve the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
yanex committed Jan 20, 2019
1 parent 0a430c1 commit 2e6195e
Show file tree
Hide file tree
Showing 82 changed files with 10,312 additions and 1,480 deletions.
602 changes: 602 additions & 0 deletions docs/api/Classes/Marco.html

Large diffs are not rendered by default.

292 changes: 292 additions & 0 deletions docs/api/Classes/Marco/Options.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,292 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Options Structure 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>

<script src="../../js/lunr.min.js" defer></script>
<script src="../../js/typeahead.jquery.js" defer></script>
<script src="../../js/jazzy.search.js" defer></script>
</head>
<body>

<a name="//apple_ref/swift/Struct/Options" class="dashAnchor"></a>

<a title="Options Structure Reference"></a>

<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../../index.html">
MarcoKit Docs
</a>

</p>

<p class="header-col--secondary">
<form role="search" action="../../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>


</header>

<p class="breadcrumbs">
<a class="breadcrumb" href="../../index.html">MarcoKit Reference</a>
<img class="carat" src="../../img/carat.png" />
Options Structure Reference
</p>

<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="../../Values.html">Values</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/MarcoValue.html">MarcoValue</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/MarcoDocument.html">MarcoDocument</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/MarcoNumberLiteral.html">MarcoNumberLiteral</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/MarcoIntLiteral.html">MarcoIntLiteral</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/MarcoDoubleLiteral.html">MarcoDoubleLiteral</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/MarcoStringLiteral.html">MarcoStringLiteral</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/MarcoBoolLiteral.html">MarcoBoolLiteral</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/MarcoArray.html">MarcoArray</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/MarcoObject.html">MarcoObject</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/MarcoIdentifier.html">MarcoIdentifier</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/MarcoNullLiteral.html">MarcoNullLiteral</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../../Parsing.html">Parsing</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/Marco.html">Marco</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/Marco/Options.html">– Options</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/MarcoParsingError.html">MarcoParsingError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Classes/MarcoNonStrictParsingError.html">MarcoNonStrictParsingError</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../../Visitor.html">Visitor</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Protocols/MarcoVisitor.html">MarcoVisitor</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Extensions/Int.html">Int</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Extensions/Int32.html">Int32</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Extensions/UInt32.html">UInt32</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Extensions/Int64.html">Int64</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Extensions/UInt64.html">UInt64</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Extensions/NSColor.html">NSColor</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Extensions/Float.html">Float</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Extensions/Double.html">Double</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Extensions/CGFloat.html">CGFloat</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Extensions/String.html">String</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Extensions/Bool.html">Bool</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../../Extensions/NSNull.html">NSNull</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">

<section class="section">
<div class="section-content">
<h1>Options</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">Options</span> <span class="p">:</span> <span class="kt">OptionSet</span></code></pre>

</div>
</div>
<p>Parsing options.</p>

</div>
</section>

<section class="section">
<div class="section-content">
<div class="task-group">
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:SY8rawValue03RawB0Qzvp"></a>
<a name="//apple_ref/swift/Property/rawValue" class="dashAnchor"></a>
<a class="token" href="#/s:SY8rawValue03RawB0Qzvp">rawValue</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">

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

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:s9OptionSetP8rawValuex03RawD0Qz_tcfc"></a>
<a name="//apple_ref/swift/Method/init(rawValue:)" class="dashAnchor"></a>
<a class="token" href="#/s:s9OptionSetP8rawValuex03RawD0Qz_tcfc">init(rawValue:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">rawValue</span><span class="p">:</span> <span class="kt">UInt</span><span class="p">)</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:8MarcoKit0A0C7OptionsV6configAEvpZ"></a>
<a name="//apple_ref/swift/Variable/config" class="dashAnchor"></a>
<a class="token" href="#/s:8MarcoKit0A0C7OptionsV6configAEvpZ">config</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Parse a configuration file.</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">let</span> <span class="nv">config</span><span class="p">:</span> <span class="kt"><a href="../../Classes/Marco.html">Marco</a></span><span class="o">.</span><span class="kt">Options</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:8MarcoKit0A0C7OptionsV9nonStrictAEvpZ"></a>
<a name="//apple_ref/swift/Variable/nonStrict" class="dashAnchor"></a>
<a class="token" href="#/s:8MarcoKit0A0C7OptionsV9nonStrictAEvpZ">nonStrict</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Throw <code><a href="../../Classes/MarcoNonStrictParsingError.html">MarcoNonStrictParsingError</a></code> in case of non-critical parsing erorrs.</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="k">let</span> <span class="nv">nonStrict</span><span class="p">:</span> <span class="kt"><a href="../../Classes/Marco.html">Marco</a></span><span class="o">.</span><span class="kt">Options</span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>

</article>
</div>
<section class="footer">
<p>&copy; 2019 <a class="link" href="https://marta.yanex.org" target="_blank" rel="external">Yan Zhulanow</a>. All rights reserved. (Last updated: 2019-01-20)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.4</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>
Loading

0 comments on commit 2e6195e

Please sign in to comment.