Skip to content

Commit 05ecb11

Browse files
indragiekindragiek
committed
Add generated documentation
1 parent e08ea41 commit 05ecb11

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+12805
-7
lines changed

‎README.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
66

77
<p align="center">
8-
<img alt="InAppViewDebugger" src="images/main.png" width="700">
8+
<img alt="InAppViewDebugger" src="docs/img/main.png" width="700">
99
</p>
1010

1111
`InAppViewDebugger` is a library that implements a view debugger with a 3D snapshot view and a hierarchy view, similar to [Reveal](https://revealapp.com) and [Xcode's own view debugger](https://developer.apple.com/library/archive/documentation/ToolsLanguages/Conceptual/Xcode_Overview/ExaminingtheViewHierarchy.html). The key distinction is, as the project title suggests, that this can be embedded inside the app and used on-device to debug UI issues without needing to be tethered to a computer.
@@ -14,7 +14,7 @@
1414

1515
* **3D snapshot view implemented in SceneKit**: Gesture controls for zooming, panning, and rotating.
1616
* **Hierarchy (tree) view that synchronizes its selection with the 3D view**: This is a feature I really wanted in Xcode, to be able to visually find a view and see where it is in the hierarchy view
17-
* **Support for [iPad](images/main.png) and [iPhone](images/iphone1.png)**: Layouts are designed specifically for each form factor.
17+
* **Support for [iPad](docs/img/main.png) and [iPhone](docs/img/iphone1.png)**: Layouts are designed specifically for each form factor.
1818
* **Extensible:** The base implementation supports `UIView` hierarchies, but this is easily extensible to support any kind of UI framework (e.g. CoreAnimation or SpriteKit)
1919

2020
## Requirements
@@ -81,39 +81,39 @@ The `present` function shows the UI hierarchy for your application's key window,
8181
To focus on the subhierarchy of a particular element, **long press on the element** to bring up the action menu and tap "Focus". The long press can be used both in the hierarchy view and the 3D snapshot view. The "Log Description" action will log the description of the element to the console, so that if you're attached to Xcode you can copy the address of the object for further debugging.
8282

8383
<p align="center">
84-
<img alt="Focusing on an Element" src="images/focus.gif" width="700">
84+
<img alt="Focusing on an Element" src="docs/img/focus.gif" width="700">
8585
</p>
8686

8787
### Adjusting Distance Between Levels
8888

8989
The slider on the bottom left of the snapshot view can be used to adjust the spacing between levels of the hierarchy:
9090

9191
<p align="center">
92-
<img alt="Adjusting Distance Between Levels" src="images/distance.gif" width="700">
92+
<img alt="Adjusting Distance Between Levels" src="docs/img/distance.gif" width="700">
9393
</p>
9494

9595
### Adjusting Visible Levels
9696

9797
The range slider on the bottom right of the snapshot view can be used to adjust the range of levels in the hierarchy that are visible:
9898

9999
<p align="center">
100-
<img alt="Adjusting Visible Levels" src="images/slicing.gif" width="700">
100+
<img alt="Adjusting Visible Levels" src="docs/img/slicing.gif" width="700">
101101
</p>
102102

103103
### Showing/Hiding Headers
104104

105105
Each UI element has a header above it that shows its class name. These headers can be hidden or shown by **long pressing on an empty area of the snapshot view** to bring up the action menu:
106106

107107
<p align="center">
108-
<img alt="Showing/Hiding Headers" src="images/headers.gif" width="700">
108+
<img alt="Showing/Hiding Headers" src="docs/img/headers.gif" width="700">
109109
</p>
110110

111111
### Showing/Hiding Borders
112112

113113
Similarly to the headers, the borders drawn around each element can also be shown or hidden:
114114

115115
<p align="center">
116-
<img alt="Showing/Hiding Borders" src="images/borders.gif" width="700">
116+
<img alt="Showing/Hiding Borders" src="docs/img/borders.gif" width="700">
117117
</p>
118118

119119
## Customization

‎docs/Classes.html‎

Lines changed: 371 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/Classes/Configuration.html‎

Lines changed: 191 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<title>Configuration Class Reference</title>
5+
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
6+
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
7+
<meta charset="utf-8">
8+
<script src="../js/jquery.min.js" defer></script>
9+
<script src="../js/jazzy.js" defer></script>
10+
11+
<script src="../js/lunr.min.js" defer></script>
12+
<script src="../js/typeahead.jquery.js" defer></script>
13+
<script src="../js/jazzy.search.js" defer></script>
14+
</head>
15+
<body>
16+
17+
<a name="//apple_ref/swift/Class/Configuration" class="dashAnchor"></a>
18+
19+
<a title="Configuration Class Reference"></a>
20+
21+
<header class="header">
22+
<p class="header-col header-col--primary">
23+
<a class="header-link" href="../index.html">
24+
InAppViewDebugger Docs
25+
</a>
26+
(95% documented)
27+
</p>
28+
29+
<p class="header-col--secondary">
30+
<form role="search" action="../search.json">
31+
<input type="text" placeholder="Search documentation" data-typeahead>
32+
</form>
33+
</p>
34+
35+
<p class="header-col header-col--secondary">
36+
<a class="header-link" href="https://github.com/indragiek/InAppViewDebugger">
37+
<img class="header-icon" src="../img/gh.png"/>
38+
View on GitHub
39+
</a>
40+
</p>
41+
42+
</header>
43+
44+
<p class="breadcrumbs">
45+
<a class="breadcrumb" href="../index.html">InAppViewDebugger Reference</a>
46+
<img class="carat" src="../img/carat.png" />
47+
Configuration Class Reference
48+
</p>
49+
50+
<div class="content-wrapper">
51+
<nav class="navigation">
52+
<ul class="nav-groups">
53+
<li class="nav-group-name">
54+
<a class="nav-group-name-link" href="../Classes.html">Classes</a>
55+
<ul class="nav-group-tasks">
56+
<li class="nav-group-task">
57+
<a class="nav-group-task-link" href="../Classes/Configuration.html">Configuration</a>
58+
</li>
59+
<li class="nav-group-task">
60+
<a class="nav-group-task-link" href="../Classes/ElementLabel.html">ElementLabel</a>
61+
</li>
62+
<li class="nav-group-task">
63+
<a class="nav-group-task-link" href="../Classes/ElementLabel/Classification.html">– Classification</a>
64+
</li>
65+
<li class="nav-group-task">
66+
<a class="nav-group-task-link" href="../Classes/HierarchyViewConfiguration.html">HierarchyViewConfiguration</a>
67+
</li>
68+
<li class="nav-group-task">
69+
<a class="nav-group-task-link" href="../Classes/InAppViewDebugger.html">InAppViewDebugger</a>
70+
</li>
71+
<li class="nav-group-task">
72+
<a class="nav-group-task-link" href="../Classes/Snapshot.html">Snapshot</a>
73+
</li>
74+
<li class="nav-group-task">
75+
<a class="nav-group-task-link" href="../Classes/SnapshotViewConfiguration.html">SnapshotViewConfiguration</a>
76+
</li>
77+
<li class="nav-group-task">
78+
<a class="nav-group-task-link" href="../Classes/SnapshotViewConfiguration/HeaderAttributes.html">– HeaderAttributes</a>
79+
</li>
80+
<li class="nav-group-task">
81+
<a class="nav-group-task-link" href="../Classes/ViewElement.html">ViewElement</a>
82+
</li>
83+
</ul>
84+
</li>
85+
<li class="nav-group-name">
86+
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
87+
<ul class="nav-group-tasks">
88+
<li class="nav-group-task">
89+
<a class="nav-group-task-link" href="../Protocols/Element.html">Element</a>
90+
</li>
91+
</ul>
92+
</li>
93+
</ul>
94+
</nav>
95+
<article class="main-content">
96+
97+
<section class="section">
98+
<div class="section-content">
99+
<h1>Configuration</h1>
100+
<div class="declaration">
101+
<div class="language">
102+
<pre class="highlight swift"><code><span class="kd">@objc(IAVDConfiguration)</span>
103+
<span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">Configuration</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
104+
105+
</div>
106+
</div>
107+
<p>Configuration options for the in app view debugger.</p>
108+
109+
</div>
110+
</section>
111+
112+
<section class="section">
113+
<div class="section-content">
114+
<div class="task-group">
115+
<ul class="item-container">
116+
<li class="item">
117+
<div>
118+
<code>
119+
<a name="/c:@M@InAppViewDebugger@objc(cs)IAVDConfiguration(py)snapshotViewConfiguration"></a>
120+
<a name="//apple_ref/swift/Property/snapshotViewConfiguration" class="dashAnchor"></a>
121+
<a class="token" href="#/c:@M@InAppViewDebugger@objc(cs)IAVDConfiguration(py)snapshotViewConfiguration">snapshotViewConfiguration</a>
122+
</code>
123+
</div>
124+
<div class="height-container">
125+
<div class="pointer-container"></div>
126+
<section class="section">
127+
<div class="pointer"></div>
128+
<div class="abstract">
129+
<p>Configuration for the 3D snapshot view.</p>
130+
131+
</div>
132+
<div class="declaration">
133+
<h4>Declaration</h4>
134+
<div class="language">
135+
<p class="aside-title">Swift</p>
136+
<pre class="highlight swift"><code><span class="kd">@objc</span>
137+
<span class="kd">public</span> <span class="k">var</span> <span class="nv">snapshotViewConfiguration</span><span class="p">:</span> <span class="kt"><a href="../Classes/SnapshotViewConfiguration.html">SnapshotViewConfiguration</a></span></code></pre>
138+
139+
</div>
140+
</div>
141+
<div class="slightly-smaller">
142+
<a href="https://github.com/indragiek/InAppViewDebugger/tree/1.0.0/InAppViewDebugger/Configuration.swift#L14">Show on GitHub</a>
143+
</div>
144+
</section>
145+
</div>
146+
</li>
147+
<li class="item">
148+
<div>
149+
<code>
150+
<a name="/c:@M@InAppViewDebugger@objc(cs)IAVDConfiguration(py)hierarchyViewConfiguration"></a>
151+
<a name="//apple_ref/swift/Property/hierarchyViewConfiguration" class="dashAnchor"></a>
152+
<a class="token" href="#/c:@M@InAppViewDebugger@objc(cs)IAVDConfiguration(py)hierarchyViewConfiguration">hierarchyViewConfiguration</a>
153+
</code>
154+
</div>
155+
<div class="height-container">
156+
<div class="pointer-container"></div>
157+
<section class="section">
158+
<div class="pointer"></div>
159+
<div class="abstract">
160+
<p>Configuration for the hierarchy (tree) view.</p>
161+
162+
</div>
163+
<div class="declaration">
164+
<h4>Declaration</h4>
165+
<div class="language">
166+
<p class="aside-title">Swift</p>
167+
<pre class="highlight swift"><code><span class="kd">@objc</span>
168+
<span class="kd">public</span> <span class="k">var</span> <span class="nv">hierarchyViewConfiguration</span><span class="p">:</span> <span class="kt"><a href="../Classes/HierarchyViewConfiguration.html">HierarchyViewConfiguration</a></span></code></pre>
169+
170+
</div>
171+
</div>
172+
<div class="slightly-smaller">
173+
<a href="https://github.com/indragiek/InAppViewDebugger/tree/1.0.0/InAppViewDebugger/Configuration.swift#L17">Show on GitHub</a>
174+
</div>
175+
</section>
176+
</div>
177+
</li>
178+
</ul>
179+
</div>
180+
</div>
181+
</section>
182+
183+
</article>
184+
</div>
185+
<section class="footer">
186+
<p>&copy; 2019 <a class="link" href="http://indragie.com" target="_blank" rel="external">Indragie Karunaratne</a>. All rights reserved. (Last updated: 2019-04-21)</p>
187+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
188+
</section>
189+
</body>
190+
</div>
191+
</html>

0 commit comments

Comments
 (0)