mirror of
https://github.com/realm/SwiftLint.git
synced 2026-06-06 20:18:40 +00:00
Automated deployment to GitHub Pages: 37167a8a35
This commit is contained in:
@@ -23,7 +23,7 @@
|
||||
<a class="header-link" href="../index.html">
|
||||
SwiftLintFramework Docs
|
||||
</a>
|
||||
(11% documented)
|
||||
(100% documented)
|
||||
</p>
|
||||
|
||||
<p class="header-col--secondary">
|
||||
@@ -64,6 +64,35 @@
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
<a class="nav-group-name-link" href="../Reporters.html">Reporters</a>
|
||||
<ul class="nav-group-tasks">
|
||||
<li class="nav-group-task">
|
||||
<a class="nav-group-task-link" href="../Structs/CSVReporter.html">CSVReporter</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a class="nav-group-task-link" href="../Structs/CheckstyleReporter.html">CheckstyleReporter</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a class="nav-group-task-link" href="../Structs/EmojiReporter.html">EmojiReporter</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a class="nav-group-task-link" href="../Structs/GitHubActionsLoggingReporter.html">GitHubActionsLoggingReporter</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a class="nav-group-task-link" href="../Structs/HTMLReporter.html">HTMLReporter</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a class="nav-group-task-link" href="../Structs/JSONReporter.html">JSONReporter</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a class="nav-group-task-link" href="../Structs/JUnitReporter.html">JUnitReporter</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a class="nav-group-task-link" href="../Structs/MarkdownReporter.html">MarkdownReporter</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
<a class="nav-group-name-link" href="../Classes.html">Classes</a>
|
||||
<ul class="nav-group-tasks">
|
||||
@@ -115,27 +144,12 @@
|
||||
<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/Array.html">Array</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a class="nav-group-task-link" href="../Extensions/FileManager.html">FileManager</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a class="nav-group-task-link" href="../Extensions/NSRegularExpression.html">NSRegularExpression</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a class="nav-group-task-link" href="../Extensions/NSRegularExpression/Options.html">– Options</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/SwiftDeclarationAttributeKind.html">SwiftDeclarationAttributeKind</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a class="nav-group-task-link" href="../Extensions/SwiftDeclarationAttributeKind/ModifierGroup.html">– ModifierGroup</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="nav-group-name">
|
||||
@@ -211,12 +225,6 @@
|
||||
<li class="nav-group-name">
|
||||
<a class="nav-group-name-link" href="../Structs.html">Structures</a>
|
||||
<ul class="nav-group-tasks">
|
||||
<li class="nav-group-task">
|
||||
<a class="nav-group-task-link" href="../Structs/CSVReporter.html">CSVReporter</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a class="nav-group-task-link" href="../Structs/CheckstyleReporter.html">CheckstyleReporter</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a class="nav-group-task-link" href="../Structs/CollectedLinter.html">CollectedLinter</a>
|
||||
</li>
|
||||
@@ -241,39 +249,18 @@
|
||||
<li class="nav-group-task">
|
||||
<a class="nav-group-task-link" href="../Structs/Correction.html">Correction</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a class="nav-group-task-link" href="../Structs/EmojiReporter.html">EmojiReporter</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a class="nav-group-task-link" href="../Structs/GitHubActionsLoggingReporter.html">GitHubActionsLoggingReporter</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a class="nav-group-task-link" href="../Structs/HTMLReporter.html">HTMLReporter</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a class="nav-group-task-link" href="../Structs/JSONReporter.html">JSONReporter</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a class="nav-group-task-link" href="../Structs/JUnitReporter.html">JUnitReporter</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a class="nav-group-task-link" href="../Structs/Linter.html">Linter</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a class="nav-group-task-link" href="../Structs/Location.html">Location</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a class="nav-group-task-link" href="../Structs/MarkdownReporter.html">MarkdownReporter</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a class="nav-group-task-link" href="../Structs/Region.html">Region</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a class="nav-group-task-link" href="../Structs/RuleDescription.html">RuleDescription</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a class="nav-group-task-link" href="../Structs.html#/s:18SwiftLintFramework17RuleDocumentationV">RuleDocumentation</a>
|
||||
</li>
|
||||
<li class="nav-group-task">
|
||||
<a class="nav-group-task-link" href="../Structs/RuleList.html">RuleList</a>
|
||||
</li>
|
||||
@@ -325,7 +312,7 @@
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<p>Undocumented</p>
|
||||
<p>A SwiftLint-aware Swift syntax token.</p>
|
||||
|
||||
</div>
|
||||
</section>
|
||||
@@ -347,7 +334,7 @@
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Undocumented</p>
|
||||
<p>The raw <code>SyntaxToken</code> obtained by SourceKitten.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
@@ -359,7 +346,7 @@
|
||||
</div>
|
||||
</div>
|
||||
<div class="slightly-smaller">
|
||||
<a href="https://github.com/realm/SwiftLint/tree/master/Source/SwiftLintFramework/Models/SwiftLintSyntaxToken.swift#L">Show on GitHub</a>
|
||||
<a href="https://github.com/realm/SwiftLint/tree/master/Source/SwiftLintFramework/Models/SwiftLintSyntaxToken.swift#L7">Show on GitHub</a>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
@@ -377,7 +364,7 @@
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Undocumented</p>
|
||||
<p>The syntax kind associated with is token.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
@@ -389,7 +376,7 @@
|
||||
</div>
|
||||
</div>
|
||||
<div class="slightly-smaller">
|
||||
<a href="https://github.com/realm/SwiftLint/tree/master/Source/SwiftLintFramework/Models/SwiftLintSyntaxToken.swift#L">Show on GitHub</a>
|
||||
<a href="https://github.com/realm/SwiftLint/tree/master/Source/SwiftLintFramework/Models/SwiftLintSyntaxToken.swift#L10">Show on GitHub</a>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
@@ -407,7 +394,7 @@
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Undocumented</p>
|
||||
<p>Creates a <code>SwiftLintSyntaxToken</code> from the raw <code>SyntaxToken</code> obtained by SourceKitten.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
@@ -418,8 +405,27 @@
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<h4>Parameters</h4>
|
||||
<table class="graybox">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>
|
||||
<em>value</em>
|
||||
</code>
|
||||
</td>
|
||||
<td>
|
||||
<div>
|
||||
<p>The raw <code>SyntaxToken</code> obtained by SourceKitten.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="slightly-smaller">
|
||||
<a href="https://github.com/realm/SwiftLint/tree/master/Source/SwiftLintFramework/Models/SwiftLintSyntaxToken.swift#L8-L11">Show on GitHub</a>
|
||||
<a href="https://github.com/realm/SwiftLint/tree/master/Source/SwiftLintFramework/Models/SwiftLintSyntaxToken.swift#L15-L18">Show on GitHub</a>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
@@ -427,9 +433,9 @@
|
||||
<li class="item">
|
||||
<div>
|
||||
<code>
|
||||
<a name="/s:18SwiftLintFramework0aB11SyntaxTokenV5range10Foundation8_NSRangeVvp"></a>
|
||||
<a name="/s:18SwiftLintFramework0aB11SyntaxTokenV5rangeSo8_NSRangeVvp"></a>
|
||||
<a name="//apple_ref/swift/Property/range" class="dashAnchor"></a>
|
||||
<a class="token" href="#/s:18SwiftLintFramework0aB11SyntaxTokenV5range10Foundation8_NSRangeVvp">range</a>
|
||||
<a class="token" href="#/s:18SwiftLintFramework0aB11SyntaxTokenV5rangeSo8_NSRangeVvp">range</a>
|
||||
</code>
|
||||
</div>
|
||||
<div class="height-container">
|
||||
@@ -437,7 +443,7 @@
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Undocumented</p>
|
||||
<p>The byte range in a source file for this token.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
@@ -449,7 +455,7 @@
|
||||
</div>
|
||||
</div>
|
||||
<div class="slightly-smaller">
|
||||
<a href="https://github.com/realm/SwiftLint/tree/master/Source/SwiftLintFramework/Models/SwiftLintSyntaxToken.swift#L13-L15">Show on GitHub</a>
|
||||
<a href="https://github.com/realm/SwiftLint/tree/master/Source/SwiftLintFramework/Models/SwiftLintSyntaxToken.swift#L21-L23">Show on GitHub</a>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
@@ -467,7 +473,7 @@
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Undocumented</p>
|
||||
<p>The starting byte offset in a source file for this token.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
@@ -479,7 +485,7 @@
|
||||
</div>
|
||||
</div>
|
||||
<div class="slightly-smaller">
|
||||
<a href="https://github.com/realm/SwiftLint/tree/master/Source/SwiftLintFramework/Models/SwiftLintSyntaxToken.swift#L17-L19">Show on GitHub</a>
|
||||
<a href="https://github.com/realm/SwiftLint/tree/master/Source/SwiftLintFramework/Models/SwiftLintSyntaxToken.swift#L26-L28">Show on GitHub</a>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
@@ -497,7 +503,7 @@
|
||||
<section class="section">
|
||||
<div class="pointer"></div>
|
||||
<div class="abstract">
|
||||
<p>Undocumented</p>
|
||||
<p>The length in bytes for this token.</p>
|
||||
|
||||
</div>
|
||||
<div class="declaration">
|
||||
@@ -509,7 +515,7 @@
|
||||
</div>
|
||||
</div>
|
||||
<div class="slightly-smaller">
|
||||
<a href="https://github.com/realm/SwiftLint/tree/master/Source/SwiftLintFramework/Models/SwiftLintSyntaxToken.swift#L21-L23">Show on GitHub</a>
|
||||
<a href="https://github.com/realm/SwiftLint/tree/master/Source/SwiftLintFramework/Models/SwiftLintSyntaxToken.swift#L31-L33">Show on GitHub</a>
|
||||
</div>
|
||||
</section>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user