Skip to content

Commit 9060b75

Browse files
weissiweissi
committed
DOC: Updated Documentation
1 parent ff718b7 commit 9060b75

8 files changed

+1220
-7
lines changed

‎FRLayeredNavigationController/FRNavigationBar.h

+8-1
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,10 @@
3030

3131
#import <UIKit/UIKit.h>
3232

33+
/**
34+
* It’s a bar, typically displayed at the top of the screen, containing the view
35+
* controller's title and optionally some buttons or other views.
36+
*/
3337
@interface FRNavigationBar : NSObject<UIAppearance>
3438

3539
/**
@@ -41,9 +45,12 @@
4145
/**
4246
* Returns an object which can be used set the style of an FRNavigationBar when embedded within other appearance
4347
* containers.
48+
*
49+
* @param ContainerClass A nil-terminated list of appearance container classes.
50+
* @param ... A nil-terminated list of appearance container classes.
4451
*/
45-
4652
+(FRNavigationBar *) appearanceWhenContainedIn: (Class <UIAppearanceContainer>)ContainerClass,...;
53+
4754
/**
4855
* The default background image of all FRNavigationBars in the application. If none is specified,
4956
* the default gray gradient of the iPad is used.

‎docs/html/Categories/UIViewController+FRLayeredNavigationController.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ <h4 class="method-subtitle">Declared In</h4>
265265
<div id="footer">
266266
<hr />
267267
<div class="footer-copyright">
268-
<p><span class="copyright">&copy; 2012 factis research GmbH. All rights reserved. (Last updated: 2012-07-29)</span><br />
268+
<p><span class="copyright">&copy; 2012 factis research GmbH. All rights reserved. (Last updated: 2012-08-28)</span><br />
269269

270270
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 789)</a>.</span></p>
271271

‎docs/html/Classes/FRLayeredNavigationController.html

+213-2
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,16 @@ <h1 class="hideInXcode">FRLayeredNavigationController Class Reference</h1>
4040

4141
<option value="properties">Properties</option>
4242

43+
<option value="//api/name/delegate">&nbsp;&nbsp;&nbsp;&nbsp;delegate</option>
44+
45+
<option value="//api/name/dropLayersWhenPulledRight">&nbsp;&nbsp;&nbsp;&nbsp;dropLayersWhenPulledRight</option>
46+
47+
<option value="//api/name/topViewController">&nbsp;&nbsp;&nbsp;&nbsp;topViewController</option>
48+
4349
<option value="//api/name/userInteractionEnabled">&nbsp;&nbsp;&nbsp;&nbsp;userInteractionEnabled</option>
4450

51+
<option value="//api/name/viewControllers">&nbsp;&nbsp;&nbsp;&nbsp;viewControllers</option>
52+
4553

4654

4755

@@ -87,8 +95,16 @@ <h1 class="hideInXcode">FRLayeredNavigationController Class Reference</h1>
8795

8896
<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#properties">Properties</a></span><ul>
8997

98+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/delegate">delegate</a></span></li>
99+
100+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/dropLayersWhenPulledRight">dropLayersWhenPulledRight</a></span></li>
101+
102+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/topViewController">topViewController</a></span></li>
103+
90104
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/userInteractionEnabled">userInteractionEnabled</a></span></li>
91105

106+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/viewControllers">viewControllers</a></span></li>
107+
92108
</ul></li>
93109

94110

@@ -230,6 +246,35 @@ <h2 class="subtitle subtitle-tasks">Tasks</h2>
230246
</span>
231247
<span class="task-item-suffix">property</span>
232248

249+
</li><li>
250+
<span class="tooltip">
251+
<code><a href="#//api/name/viewControllers">&nbsp;&nbsp;viewControllers</a></code>
252+
<span class="tooltip"><p>Returns all the UIViewController objects being managed by the FRNavigationController.
253+
Note that, unlike a UINavigationController, this is a readonly property.</p></span>
254+
</span>
255+
<span class="task-item-suffix">property</span>
256+
257+
</li><li>
258+
<span class="tooltip">
259+
<code><a href="#//api/name/dropLayersWhenPulledRight">&nbsp;&nbsp;dropLayersWhenPulledRight</a></code>
260+
<span class="tooltip"><p>Wheater to drop all layers except the root view controller when pulled far enough to the right</p></span>
261+
</span>
262+
<span class="task-item-suffix">property</span>
263+
264+
</li><li>
265+
<span class="tooltip">
266+
<code><a href="#//api/name/topViewController">&nbsp;&nbsp;topViewController</a></code>
267+
<span class="tooltip"><p>The view controller in the top layer. (read-only)</p></span>
268+
</span>
269+
<span class="task-item-suffix">property</span>
270+
271+
</li><li>
272+
<span class="tooltip">
273+
<code><a href="#//api/name/delegate">&nbsp;&nbsp;delegate</a></code>
274+
<span class="tooltip"><p>The delegate for the controller.</p></span>
275+
</span>
276+
<span class="task-item-suffix">property</span>
277+
233278
</li>
234279
</ul>
235280

@@ -243,6 +288,129 @@ <h2 class="subtitle subtitle-tasks">Tasks</h2>
243288
<a title="Properties" name="properties"></a>
244289
<h2 class="subtitle subtitle-methods">Properties</h2>
245290

291+
<div class="section-method">
292+
<a name="//api/name/delegate" title="delegate"></a>
293+
<h3 class="subsubtitle method-title">delegate</h3>
294+
295+
296+
297+
<div class="method-subsection brief-description">
298+
<p>The delegate for the controller.</p>
299+
</div>
300+
301+
302+
303+
<div class="method-subsection method-declaration"><code>@property (nonatomic, weak) id&lt;&gt; delegate</code></div>
304+
305+
306+
307+
308+
309+
310+
311+
312+
313+
<div class="method-subsection discussion-section">
314+
<h4 class="method-subtitle">Discussion</h4>
315+
<p>The delegate for the controller.</p>
316+
</div>
317+
318+
319+
320+
321+
322+
323+
324+
<div class="method-subsection declared-in-section">
325+
<h4 class="method-subtitle">Declared In</h4>
326+
<code class="declared-in-ref">FRLayeredNavigationController.h</code><br />
327+
</div>
328+
329+
330+
</div>
331+
332+
<div class="section-method">
333+
<a name="//api/name/dropLayersWhenPulledRight" title="dropLayersWhenPulledRight"></a>
334+
<h3 class="subsubtitle method-title">dropLayersWhenPulledRight</h3>
335+
336+
337+
338+
<div class="method-subsection brief-description">
339+
<p>Wheater to drop all layers except the root view controller when pulled far enough to the right</p>
340+
</div>
341+
342+
343+
344+
<div class="method-subsection method-declaration"><code>@property (nonatomic) BOOL dropLayersWhenPulledRight</code></div>
345+
346+
347+
348+
349+
350+
351+
352+
353+
354+
<div class="method-subsection discussion-section">
355+
<h4 class="method-subtitle">Discussion</h4>
356+
<p>Wheater to drop all layers except the root view controller when pulled far enough to the right</p>
357+
</div>
358+
359+
360+
361+
362+
363+
364+
365+
<div class="method-subsection declared-in-section">
366+
<h4 class="method-subtitle">Declared In</h4>
367+
<code class="declared-in-ref">FRLayeredNavigationController.h</code><br />
368+
</div>
369+
370+
371+
</div>
372+
373+
<div class="section-method">
374+
<a name="//api/name/topViewController" title="topViewController"></a>
375+
<h3 class="subsubtitle method-title">topViewController</h3>
376+
377+
378+
379+
<div class="method-subsection brief-description">
380+
<p>The view controller in the top layer. (read-only)</p>
381+
</div>
382+
383+
384+
385+
<div class="method-subsection method-declaration"><code>@property (nonatomic, readonly) UIViewController *topViewController</code></div>
386+
387+
388+
389+
390+
391+
392+
393+
394+
395+
<div class="method-subsection discussion-section">
396+
<h4 class="method-subtitle">Discussion</h4>
397+
<p>The view controller in the top layer. (read-only)</p>
398+
</div>
399+
400+
401+
402+
403+
404+
405+
406+
<div class="method-subsection declared-in-section">
407+
<h4 class="method-subtitle">Declared In</h4>
408+
<code class="declared-in-ref">FRLayeredNavigationController.h</code><br />
409+
</div>
410+
411+
412+
</div>
413+
246414
<div class="section-method">
247415
<a name="//api/name/userInteractionEnabled" title="userInteractionEnabled"></a>
248416
<h3 class="subsubtitle method-title">userInteractionEnabled</h3>
@@ -276,6 +444,49 @@ <h4 class="method-subtitle">Discussion</h4>
276444

277445

278446

447+
<div class="method-subsection declared-in-section">
448+
<h4 class="method-subtitle">Declared In</h4>
449+
<code class="declared-in-ref">FRLayeredNavigationController.h</code><br />
450+
</div>
451+
452+
453+
</div>
454+
455+
<div class="section-method">
456+
<a name="//api/name/viewControllers" title="viewControllers"></a>
457+
<h3 class="subsubtitle method-title">viewControllers</h3>
458+
459+
460+
461+
<div class="method-subsection brief-description">
462+
<p>Returns all the UIViewController objects being managed by the FRNavigationController.
463+
Note that, unlike a UINavigationController, this is a readonly property.</p>
464+
</div>
465+
466+
467+
468+
<div class="method-subsection method-declaration"><code>@property (nonatomic, readonly) NSArray *viewControllers</code></div>
469+
470+
471+
472+
473+
474+
475+
476+
477+
478+
<div class="method-subsection discussion-section">
479+
<h4 class="method-subtitle">Discussion</h4>
480+
<p>Returns all the UIViewController objects being managed by the FRNavigationController.
481+
Note that, unlike a UINavigationController, this is a readonly property.</p>
482+
</div>
483+
484+
485+
486+
487+
488+
489+
279490
<div class="method-subsection declared-in-section">
280491
<h4 class="method-subtitle">Declared In</h4>
281492
<code class="declared-in-ref">FRLayeredNavigationController.h</code><br />
@@ -682,7 +893,7 @@ <h4 class="method-subtitle parameter-title">Parameters</h4>
682893
<dl class="argument-def parameter-def">
683894
<dt><em>configuration</em></dt>
684895
<dd><p>A block object you can use to control some parameters (such as the width) for the new view
685-
controller. The block&rsquo;s only parameter is an newly created instance of <a href="../Classes/FRLayeredNavigationItem.html">FRLayeredNavigationItem</a> .</p></dd>
896+
controller. The block&rsquo;s only parameter is a newly created instance of <a href="../Classes/FRLayeredNavigationItem.html">FRLayeredNavigationItem</a> .</p></dd>
686897
</dl>
687898

688899
</div>
@@ -726,7 +937,7 @@ <h4 class="method-subtitle">Declared In</h4>
726937
<div id="footer">
727938
<hr />
728939
<div class="footer-copyright">
729-
<p><span class="copyright">&copy; 2012 factis research GmbH. All rights reserved. (Last updated: 2012-07-29)</span><br />
940+
<p><span class="copyright">&copy; 2012 factis research GmbH. All rights reserved. (Last updated: 2012-08-28)</span><br />
730941

731942
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 789)</a>.</span></p>
732943

‎docs/html/Classes/FRLayeredNavigationItem.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -675,7 +675,7 @@ <h4 class="method-subtitle">Declared In</h4>
675675
<div id="footer">
676676
<hr />
677677
<div class="footer-copyright">
678-
<p><span class="copyright">&copy; 2012 factis research GmbH. All rights reserved. (Last updated: 2012-07-29)</span><br />
678+
<p><span class="copyright">&copy; 2012 factis research GmbH. All rights reserved. (Last updated: 2012-08-28)</span><br />
679679

680680
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 789)</a>.</span></p>
681681

0 commit comments

Comments
 (0)