Skip to content
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

Tracking for Treatment of Undocumented Symbols #33

Closed
wants to merge 10 commits into from
Closed

Tracking for Treatment of Undocumented Symbols #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
28b2172
Added test for behaviour for undocumented symbols.
SDGGiesbrecht May 26, 2017
5255265
Removed redundant classes and structures
SDGGiesbrecht May 31, 2017
5d59bea
Added class external not just to module, but to module group.
SDGGiesbrecht May 31, 2017
bc7c082
Removed direct quotations of :nodoc:
SDGGiesbrecht May 31, 2017
6cdf7ac
Switched to American in files.
SDGGiesbrecht May 31, 2017
ae1472f
Switched to American in filenames.
SDGGiesbrecht May 31, 2017
3c18e79
Regenerated Xcode project.
SDGGiesbrecht May 31, 2017
1959857
Added gitignore
SDGGiesbrecht May 31, 2017
99edf4b
Removed existing .DS_Store files.
SDGGiesbrecht May 31, 2017
7540ea5
Regenerated fixtures.
SDGGiesbrecht May 31, 2017
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.DS_Store
111 changes: 111 additions & 0 deletions behaviors_for_undocumented/after/docs/Extensions.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Extensions 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="Extensions Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html"> Docs</a> (70% documented)</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="index.html"> Reference</a>
<img id="carat" src="img/carat.png" />
Extensions Reference
</p>
</div>
<div class="content-wrapper">
<nav class="sidebar">
<ul class="nav-groups">
<li class="nav-group-name">
<a href="Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Extensions/LocalOptedOutStructure.html">LocalOptedOutStructure</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/Should_be_VISIBLE_because_documentation_exists_for_protocol.html">Should_be_VISIBLE_because_documentation_exists_for_protocol</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Structs.html">Structs</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Structs/LocalDocumentedStructure.html">LocalDocumentedStructure</a>
</li>
<li class="nav-group-task">
<a href="Structs/Should_be_VISIBLE_because_documentation_exists_for_structure.html">Should_be_VISIBLE_because_documentation_exists_for_structure</a>
</li>
<li class="nav-group-task">
<a href="Structs/UndocumentedExtension_Should_NOT_WARN.html">UndocumentedExtension_Should_NOT_WARN</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>Extensions</h1>
<p>The following extensions are available globally.</p>

</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:V9Behaviors22LocalOptedOutStructure"></a>
<a name="//apple_ref/swift/Extension/LocalOptedOutStructure" class="dashAnchor"></a>
<a class="token" href="#/s:V9Behaviors22LocalOptedOutStructure">LocalOptedOutStructure</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>This extension should be HIDDEN because the main declaration is opted out.</p>

<a href="Extensions/LocalOptedOutStructure.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">LocalOptedOutStructure</span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; YYYY <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: YYYY-MM-DD)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ vX.X.X</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>
179 changes: 179 additions & 0 deletions behaviors_for_undocumented/after/docs/Extensions/LocalOptedOutStructure.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,179 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>LocalOptedOutStructure Extension 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/Extension/LocalOptedOutStructure" class="dashAnchor"></a>
<a title="LocalOptedOutStructure Extension Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (70% documented)</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html"> Reference</a>
<img id="carat" src="../img/carat.png" />
LocalOptedOutStructure Extension Reference
</p>
</div>
<div class="content-wrapper">
<nav class="sidebar">
<ul class="nav-groups">
<li class="nav-group-name">
<a href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Extensions/LocalOptedOutStructure.html">LocalOptedOutStructure</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/Should_be_VISIBLE_because_documentation_exists_for_protocol.html">Should_be_VISIBLE_because_documentation_exists_for_protocol</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Structs.html">Structs</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Structs/LocalDocumentedStructure.html">LocalDocumentedStructure</a>
</li>
<li class="nav-group-task">
<a href="../Structs/Should_be_VISIBLE_because_documentation_exists_for_structure.html">Should_be_VISIBLE_because_documentation_exists_for_structure</a>
</li>
<li class="nav-group-task">
<a href="../Structs/UndocumentedExtension_Should_NOT_WARN.html">UndocumentedExtension_Should_NOT_WARN</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>LocalOptedOutStructure</h1>
<div class="declaration">
<div class="language">
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">LocalOptedOutStructure</span></code></pre>

</div>
</div>
<p>This extension should be HIDDEN because the main declaration is opted out.</p>

</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:FV9Behaviors22LocalOptedOutStructure56should_be_HIDDEN_because_main_declaration_is_opted_out_dFT_T_"></a>
<a name="//apple_ref/swift/Method/should_be_HIDDEN_because_main_declaration_is_opted_out_d()" class="dashAnchor"></a>
<a class="token" href="#/s:FV9Behaviors22LocalOptedOutStructure56should_be_HIDDEN_because_main_declaration_is_opted_out_dFT_T_">should_be_HIDDEN_because_main_declaration_is_opted_out_d()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Should be HIDDEN because the main declaration is opted out.</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="kd">func</span> <span class="nf">should_be_HIDDEN_because_main_declaration_is_opted_out_d</span><span class="p">()</span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:FV9Behaviors22LocalOptedOutStructure15extensionMethodFT_T_"></a>
<a name="//apple_ref/swift/Method/extensionMethod()" class="dashAnchor"></a>
<a class="token" href="#/s:FV9Behaviors22LocalOptedOutStructure15extensionMethodFT_T_">extensionMethod()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>An extension method (to ensure the extension is not empty.)</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="kd">func</span> <span class="nf">extensionMethod</span><span class="p">()</span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:FV9Behaviors22LocalOptedOutStructure56should_be_HIDDEN_because_main_declaration_is_opted_out_uFT_T_"></a>
<a name="//apple_ref/swift/Method/should_be_HIDDEN_because_main_declaration_is_opted_out_u()" class="dashAnchor"></a>
<a class="token" href="#/s:FV9Behaviors22LocalOptedOutStructure56should_be_HIDDEN_because_main_declaration_is_opted_out_uFT_T_">should_be_HIDDEN_because_main_declaration_is_opted_out_u()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Should be HIDDEN because the main declaration is opted out.</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="kd">func</span> <span class="nf">should_be_HIDDEN_because_main_declaration_is_opted_out_u</span><span class="p">()</span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; YYYY <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: YYYY-MM-DD)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ vX.X.X</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>
Loading