Skip to content

Support for documentation folder #88

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
raulriera merged 3 commits into from
May 14, 2018
Merged

Support for documentation folder #88

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1087dbe
Support for documentation folder
raulriera May 14, 2018
5c48886
Added the configuration file
raulriera May 14, 2018
d88e82d
Ignore jazzy and the undocumented json file
raulriera May 14, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,6 @@ profile
*/fastlane/report.xml
*/fastlane/*.coverage.txt
FunctionalTableData/build/*
.dev
.dev

docs/docs/undocumented.json
4 changes: 4 additions & 0 deletions .jazzy.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Ordered by output of `jazzy --help config`

skip_undocumented: true
hide_documentation_coverage: true
403 changes: 403 additions & 0 deletions docs/Classes.html
View file
Open in desktop

Large diffs are not rendered by default.

360 changes: 360 additions & 0 deletions docs/Classes/CollectionCell.html
View file
Open in desktop

Large diffs are not rendered by default.

1,946 changes: 1,946 additions & 0 deletions docs/Classes/FunctionalCollectionData.html
View file
Open in desktop

Large diffs are not rendered by default.

335 changes: 335 additions & 0 deletions docs/Classes/FunctionalCollectionData/KeyPath.html
View file
Open in desktop

Large diffs are not rendered by default.

2,364 changes: 2,364 additions & 0 deletions docs/Classes/FunctionalTableData.html
View file
Open in desktop

Large diffs are not rendered by default.

414 changes: 414 additions & 0 deletions docs/Classes/FunctionalTableData/Exception.html
View file
Open in desktop

Large diffs are not rendered by default.

309 changes: 309 additions & 0 deletions docs/Classes/FunctionalTableData/KeyPath.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,309 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>KeyPath 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>

</head>
<body>
<a name="//apple_ref/swift/Struct/KeyPath" class="dashAnchor"></a>
<a title="KeyPath Structure Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../../index.html"> Docs</a> (27% documented)</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../../index.html"> Reference</a>
<img id="carat" src="../../img/carat.png" />
KeyPath Structure Reference
</p>
</div>
<div class="content-wrapper">
<nav class="sidebar">
<ul class="nav-groups">
<li class="nav-group-name">
<a href="../../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../../Classes/CollectionCell.html">CollectionCell</a>
</li>
<li class="nav-group-task">
<a href="../../Classes/FunctionalCollectionData.html">FunctionalCollectionData</a>
</li>
<li class="nav-group-task">
<a href="../../Classes/FunctionalCollectionData/KeyPath.html">– KeyPath</a>
</li>
<li class="nav-group-task">
<a href="../../Classes/FunctionalTableData.html">FunctionalTableData</a>
</li>
<li class="nav-group-task">
<a href="../../Classes/FunctionalTableData/Exception.html">– Exception</a>
</li>
<li class="nav-group-task">
<a href="../../Classes/FunctionalTableData/KeyPath.html">– KeyPath</a>
</li>
<li class="nav-group-task">
<a href="../../Classes/FunctionalTableData/TableAnimations.html">– TableAnimations</a>
</li>
<li class="nav-group-task">
<a href="../../Classes/Separator.html">Separator</a>
</li>
<li class="nav-group-task">
<a href="../../Classes/Separator/Style.html">– Style</a>
</li>
<li class="nav-group-task">
<a href="../../Classes/Separator/Tag.html">– Tag</a>
</li>
<li class="nav-group-task">
<a href="../../Classes/TableCell.html">TableCell</a>
</li>
<li class="nav-group-task">
<a href="../../Classes/TableHeaderFooter.html">TableHeaderFooter</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../../Enums/EdgeLayout.html">EdgeLayout</a>
</li>
<li class="nav-group-task">
<a href="../../Enums/EdgeLayout/Horizontal.html">– Horizontal</a>
</li>
<li class="nav-group-task">
<a href="../../Enums/EdgeLayout/Vertical.html">– Vertical</a>
</li>
<li class="nav-group-task">
<a href="../../Enums/MarginsLayout.html">MarginsLayout</a>
</li>
<li class="nav-group-task">
<a href="../../Enums/MarginsLayout/Horizontal.html">– Horizontal</a>
</li>
<li class="nav-group-task">
<a href="../../Enums/MarginsLayout/Vertical.html">– Vertical</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../../Extensions/NSException.html">NSException</a>
</li>
<li class="nav-group-task">
<a href="../../Extensions/UICollectionView.html">UICollectionView</a>
</li>
<li class="nav-group-task">
<a href="../../Extensions/UITableView.html">UITableView</a>
</li>
<li class="nav-group-task">
<a href="../../Extensions/UIView.html">UIView</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../../Protocols/CellConfigType.html">CellConfigType</a>
</li>
<li class="nav-group-task">
<a href="../../Protocols/CollectionItemConfigType.html">CollectionItemConfigType</a>
</li>
<li class="nav-group-task">
<a href="../../Protocols/FunctionalTableDataExceptionHandler.html">FunctionalTableDataExceptionHandler</a>
</li>
<li class="nav-group-task">
<a href="../../Protocols/Reusable.html">Reusable</a>
</li>
<li class="nav-group-task">
<a href="../../Protocols/TableHeaderFooterConfigType.html">TableHeaderFooterConfigType</a>
</li>
<li class="nav-group-task">
<a href="../../Protocols/TableHeaderFooterStateType.html">TableHeaderFooterStateType</a>
</li>
<li class="nav-group-task">
<a href="../../Protocols/TableItemConfigType.html">TableItemConfigType</a>
</li>
<li class="nav-group-task">
<a href="../../Protocols/TableItemLayout.html">TableItemLayout</a>
</li>
<li class="nav-group-task">
<a href="../../Protocols/TableSectionType.html">TableSectionType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../../Structs/CellActions.html">CellActions</a>
</li>
<li class="nav-group-task">
<a href="../../Structs/CellActions/SelectionState.html">– SelectionState</a>
</li>
<li class="nav-group-task">
<a href="../../Structs/CellStyle.html">CellStyle</a>
</li>
<li class="nav-group-task">
<a href="../../Structs/CombinedLayout.html">CombinedLayout</a>
</li>
<li class="nav-group-task">
<a href="../../Structs/ExplicitLayoutMarginsTableItemLayout.html">ExplicitLayoutMarginsTableItemLayout</a>
</li>
<li class="nav-group-task">
<a href="../../Structs/HostCell.html">HostCell</a>
</li>
<li class="nav-group-task">
<a href="../../Structs/SectionStyle.html">SectionStyle</a>
</li>
<li class="nav-group-task">
<a href="../../Structs/SectionStyle/Separators.html">– Separators</a>
</li>
<li class="nav-group-task">
<a href="../../Structs/TableSection.html">TableSection</a>
</li>
<li class="nav-group-task">
<a href="../../Structs/TableSectionChangeSet.html">TableSectionChangeSet</a>
</li>
<li class="nav-group-task">
<a href="../../Structs/TableSectionHeaderFooter.html">TableSectionHeaderFooter</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../../Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../../Typealiases.html#/s:19FunctionalTableData09EdgeBasedB10ItemLayouta">EdgeBasedTableItemLayout</a>
</li>
<li class="nav-group-task">
<a href="../../Typealiases.html#/s:19FunctionalTableData013LayoutMarginsb4ItemD0a">LayoutMarginsTableItemLayout</a>
</li>
<li class="nav-group-task">
<a href="../../Typealiases.html#/s:19FunctionalTableData0B16HeaderConfigTypea">TableHeaderConfigType</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>KeyPath</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">KeyPath</span></code></pre>

</div>
</div>
<p>Represents the unique path to a given item in the <code><a href="../../Classes/FunctionalTableData.html">FunctionalTableData</a></code>.</p>

<p>Think of it as a readable implementation of <code>IndexPath</code>, that can be used to locate a given cell
or <code><a href="../../Structs/TableSection.html">TableSection</a></code> in the data set.</p>

</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:19FunctionalTableDataAAC7KeyPathV07sectionD0SSvp"></a>
<a name="//apple_ref/swift/Property/sectionKey" class="dashAnchor"></a>
<a class="token" href="#/s:19FunctionalTableDataAAC7KeyPathV07sectionD0SSvp">sectionKey</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Unique identifier for a section.</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="k">let</span> <span class="nv">sectionKey</span><span class="p">:</span> <span class="kt">String</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:19FunctionalTableDataAAC7KeyPathV03rowD0SSvp"></a>
<a name="//apple_ref/swift/Property/rowKey" class="dashAnchor"></a>
<a class="token" href="#/s:19FunctionalTableDataAAC7KeyPathV03rowD0SSvp">rowKey</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Unique identifier for an item inside a section.</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="k">let</span> <span class="nv">rowKey</span><span class="p">:</span> <span class="kt">String</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:19FunctionalTableDataAAC7KeyPathVADSS07sectionD0_SS03rowD0tcfc"></a>
<a name="//apple_ref/swift/Method/init(sectionKey:rowKey:)" class="dashAnchor"></a>
<a class="token" href="#/s:19FunctionalTableDataAAC7KeyPathVADSS07sectionD0_SS03rowD0tcfc">init(sectionKey:rowKey:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</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="nf">init</span><span class="p">(</span><span class="nv">sectionKey</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">rowKey</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2018-05-14)</p>
<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>
</section>
</article>
</div>
</body>
</div>
</html>
Loading