Skip to content

Commit 3f93ef8

Browse files
indragiekindragiek
committed
Add missing documentation
1 parent 05ecb11 commit 3f93ef8

33 files changed

+104
-107
lines changed

‎InAppViewDebugger/Element.swift‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ import CoreGraphics
1313
@objc(IAVDElementLabel) public final class ElementLabel: NSObject {
1414
/// Classification for an element that determines how it is represented
1515
/// in the view debugger.
16-
///
17-
/// - normal: An element of normal importance.
18-
/// - important: An element of higher importance that is highlighted.
1916
@objc(IAVDElementClassification) public enum Classification: Int {
17+
/// An element of normal importance.
2018
case normal
19+
20+
/// An element of higher importance that is highlighted
2121
case important
2222
}
2323

‎InAppViewDebugger/ViewElement.swift‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,9 @@ import UIKit
6161

6262
private weak var view: UIView?
6363

64+
/// Constructs a new `ViewElement`
65+
///
66+
/// - Parameter view: The `UIView` to create the element for.
6467
@objc public init(view: UIView) {
6568
self.view = view
6669
}

‎docs/Classes.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<a class="header-link" href="index.html">
2424
InAppViewDebugger Docs
2525
</a>
26-
(95% documented)
26+
(100% documented)
2727
</p>
2828

2929
<p class="header-col--secondary">
@@ -350,7 +350,7 @@ <h4>Declaration</h4>
350350
</div>
351351
</div>
352352
<div class="slightly-smaller">
353-
<a href="https://github.com/indragiek/InAppViewDebugger/tree/1.0.0/InAppViewDebugger/ViewElement.swift#L12-L67">Show on GitHub</a>
353+
<a href="https://github.com/indragiek/InAppViewDebugger/tree/1.0.0/InAppViewDebugger/ViewElement.swift#L12-L70">Show on GitHub</a>
354354
</div>
355355
</section>
356356
</div>

‎docs/Classes/Configuration.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<a class="header-link" href="../index.html">
2424
InAppViewDebugger Docs
2525
</a>
26-
(95% documented)
26+
(100% documented)
2727
</p>
2828

2929
<p class="header-col--secondary">

‎docs/Classes/ElementLabel.html‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<a class="header-link" href="../index.html">
2424
InAppViewDebugger Docs
2525
</a>
26-
(95% documented)
26+
(100% documented)
2727
</p>
2828

2929
<p class="header-col--secondary">
@@ -129,12 +129,6 @@ <h1>ElementLabel</h1>
129129
<div class="abstract">
130130
<p>Classification for an element that determines how it is represented
131131
in the view debugger.</p>
132-
<li>normal: An element of normal importance.</li>
133-
<div class="aside aside-important">
134-
<p class="aside-title">Important</p>
135-
An element of higher importance that is highlighted.
136-
137-
</div>
138132

139133
<a href="../Classes/ElementLabel/Classification.html" class="slightly-smaller">See more</a>
140134
</div>
@@ -148,7 +142,7 @@ <h4>Declaration</h4>
148142
</div>
149143
</div>
150144
<div class="slightly-smaller">
151-
<a href="https://github.com/indragiek/InAppViewDebugger/tree/1.0.0/InAppViewDebugger/Element.swift#L19-L22">Show on GitHub</a>
145+
<a href="https://github.com/indragiek/InAppViewDebugger/tree/1.0.0/InAppViewDebugger/Element.swift#L16-L22">Show on GitHub</a>
152146
</div>
153147
</section>
154148
</div>

‎docs/Classes/ElementLabel/Classification.html‎

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<a class="header-link" href="../../index.html">
2424
InAppViewDebugger Docs
2525
</a>
26-
(95% documented)
26+
(100% documented)
2727
</p>
2828

2929
<p class="header-col--secondary">
@@ -106,12 +106,6 @@ <h1>Classification</h1>
106106
</div>
107107
<p>Classification for an element that determines how it is represented
108108
in the view debugger.</p>
109-
<li>normal: An element of normal importance.</li>
110-
<div class="aside aside-important">
111-
<p class="aside-title">Important</p>
112-
An element of higher importance that is highlighted.
113-
114-
</div>
115109

116110
</div>
117111
</section>
@@ -133,7 +127,7 @@ <h1>Classification</h1>
133127
<section class="section">
134128
<div class="pointer"></div>
135129
<div class="abstract">
136-
<p>Undocumented</p>
130+
<p>An element of normal importance.</p>
137131

138132
</div>
139133
<div class="declaration">
@@ -145,7 +139,7 @@ <h4>Declaration</h4>
145139
</div>
146140
</div>
147141
<div class="slightly-smaller">
148-
<a href="https://github.com/indragiek/InAppViewDebugger/tree/1.0.0/InAppViewDebugger/Element.swift#L">Show on GitHub</a>
142+
<a href="https://github.com/indragiek/InAppViewDebugger/tree/1.0.0/InAppViewDebugger/Element.swift#L18">Show on GitHub</a>
149143
</div>
150144
</section>
151145
</div>
@@ -163,7 +157,7 @@ <h4>Declaration</h4>
163157
<section class="section">
164158
<div class="pointer"></div>
165159
<div class="abstract">
166-
<p>Undocumented</p>
160+
<p>An element of higher importance that is highlighted</p>
167161

168162
</div>
169163
<div class="declaration">
@@ -175,7 +169,7 @@ <h4>Declaration</h4>
175169
</div>
176170
</div>
177171
<div class="slightly-smaller">
178-
<a href="https://github.com/indragiek/InAppViewDebugger/tree/1.0.0/InAppViewDebugger/Element.swift#L">Show on GitHub</a>
172+
<a href="https://github.com/indragiek/InAppViewDebugger/tree/1.0.0/InAppViewDebugger/Element.swift#L21">Show on GitHub</a>
179173
</div>
180174
</section>
181175
</div>

‎docs/Classes/HierarchyViewConfiguration.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<a class="header-link" href="../index.html">
2424
InAppViewDebugger Docs
2525
</a>
26-
(95% documented)
26+
(100% documented)
2727
</p>
2828

2929
<p class="header-col--secondary">

‎docs/Classes/InAppViewDebugger.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<a class="header-link" href="../index.html">
2424
InAppViewDebugger Docs
2525
</a>
26-
(95% documented)
26+
(100% documented)
2727
</p>
2828

2929
<p class="header-col--secondary">

‎docs/Classes/Snapshot.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<a class="header-link" href="../index.html">
2424
InAppViewDebugger Docs
2525
</a>
26-
(95% documented)
26+
(100% documented)
2727
</p>
2828

2929
<p class="header-col--secondary">

‎docs/Classes/SnapshotViewConfiguration.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<a class="header-link" href="../index.html">
2424
InAppViewDebugger Docs
2525
</a>
26-
(95% documented)
26+
(100% documented)
2727
</p>
2828

2929
<p class="header-col--secondary">

0 commit comments

Comments
 (0)