Skip to content

Commit

Permalink
Updated Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
NinjaKittenProductions committed May 12, 2014
1 parent 6ea8d8d commit b0367b0
Show file tree
Hide file tree
Showing 60 changed files with 10,098 additions and 1,778 deletions.
2 changes: 1 addition & 1 deletion Documentation/docset-installed.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Documentation set was installed to Xcode!

Path: /Users/Brandon/Library/Developer/Shared/Documentation/DocSets/com.BrandonMcQuilkin.M13ProgressSuite.docset
Time: 2014-02-19 14:59:02 +0000
Time: 2014-05-12 13:29:03 +0000
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,18 @@ <h1 class="hideInXcode">UINavigationController(M13ProgressViewBar) Category Refe

<option value="//api/name/finishProgress">&nbsp;&nbsp;&nbsp;&nbsp;- finishProgress</option>

<option value="//api/name/isShowingProgressBar">&nbsp;&nbsp;&nbsp;&nbsp;- isShowingProgressBar</option>

<option value="//api/name/setIndeterminate:">&nbsp;&nbsp;&nbsp;&nbsp;- setIndeterminate:</option>

<option value="//api/name/setPrimaryColor:">&nbsp;&nbsp;&nbsp;&nbsp;- setPrimaryColor:</option>

<option value="//api/name/setProgress:animated:">&nbsp;&nbsp;&nbsp;&nbsp;- setProgress:animated:</option>

<option value="//api/name/setProgressTitle:">&nbsp;&nbsp;&nbsp;&nbsp;- setProgressTitle:</option>

<option value="//api/name/setSecondaryColor:">&nbsp;&nbsp;&nbsp;&nbsp;- setSecondaryColor:</option>

<option value="//api/name/showProgress">&nbsp;&nbsp;&nbsp;&nbsp;- showProgress</option>


Expand Down Expand Up @@ -89,12 +95,18 @@ <h1 class="hideInXcode">UINavigationController(M13ProgressViewBar) Category Refe

<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/finishProgress">finishProgress</a></span></li>

<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isShowingProgressBar">isShowingProgressBar</a></span></li>

<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setIndeterminate:">setIndeterminate:</a></span></li>

<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setPrimaryColor:">setPrimaryColor:</a></span></li>

<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setProgress:animated:">setProgress:animated:</a></span></li>

<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setProgressTitle:">setProgressTitle:</a></span></li>

<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setSecondaryColor:">setSecondaryColor:</a></span></li>

<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/showProgress">showProgress</a></span></li>

</ul></li>
Expand Down Expand Up @@ -183,6 +195,24 @@ <h3 class="subsubtitle task-title">Actions</h3>
</span>


</li><li>
<span class="tooltip">
<code><a href="#//api/name/isShowingProgressBar">&ndash;&nbsp;isShowingProgressBar</a></code>
</span>


</li><li>
<span class="tooltip">
<code><a href="#//api/name/setPrimaryColor:">&ndash;&nbsp;setPrimaryColor:</a></code>
</span>


</li><li>
<span class="tooltip">
<code><a href="#//api/name/setSecondaryColor:">&ndash;&nbsp;setSecondaryColor:</a></code>
</span>


</li>
</ul>

Expand Down Expand Up @@ -264,6 +294,42 @@ <h3 class="subsubtitle method-title">finishProgress</h3>



<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">UINavigationController+M13ProgressViewBar.h</code><br />
</div>


</div>

<div class="section-method">
<a name="//api/name/isShowingProgressBar" title="isShowingProgressBar"></a>
<h3 class="subsubtitle method-title">isShowingProgressBar</h3>



<div class="method-subsection brief-description">
<p>Wether or not the progress bar is showing.</p>
</div>



<div class="method-subsection method-declaration"><code>- (BOOL)isShowingProgressBar</code></div>















<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">UINavigationController+M13ProgressViewBar.h</code><br />
Expand Down Expand Up @@ -310,6 +376,52 @@ <h4 class="method-subtitle parameter-title">Parameters</h4>



<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">UINavigationController+M13ProgressViewBar.h</code><br />
</div>


</div>

<div class="section-method">
<a name="//api/name/setPrimaryColor:" title="setPrimaryColor:"></a>
<h3 class="subsubtitle method-title">setPrimaryColor:</h3>



<div class="method-subsection brief-description">
<p>The primary color of the progress bar if you do not want it to be the same as the UINavigationBar&rsquo;s tint color. If set to nil, the UINavigationBar&rsquo;s tint color will be used.</p>
</div>



<div class="method-subsection method-declaration"><code>- (void)setPrimaryColor:(UIColor *)<em>primaryColor</em></code></div>



<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>

<dl class="argument-def parameter-def">
<dt><em>primaryColor</em></dt>
<dd><p>The color to set.</p></dd>
</dl>

</div>













<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">UINavigationController+M13ProgressViewBar.h</code><br />
Expand Down Expand Up @@ -407,6 +519,52 @@ <h4 class="method-subtitle parameter-title">Parameters</h4>



<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">UINavigationController+M13ProgressViewBar.h</code><br />
</div>


</div>

<div class="section-method">
<a name="//api/name/setSecondaryColor:" title="setSecondaryColor:"></a>
<h3 class="subsubtitle method-title">setSecondaryColor:</h3>



<div class="method-subsection brief-description">
<p>The secondary color of the progress bar, if nil, the secondary color will be the barTintColor.</p>
</div>



<div class="method-subsection method-declaration"><code>- (void)setSecondaryColor:(UIColor *)<em>secondaryColor</em></code></div>



<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>

<dl class="argument-def parameter-def">
<dt><em>secondaryColor</em></dt>
<dd><p>The color to set.</p></dd>
</dl>

</div>













<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">UINavigationController+M13ProgressViewBar.h</code><br />
Expand Down Expand Up @@ -466,7 +624,7 @@ <h4 class="method-subtitle">Declared In</h4>
<div id="footer">
<hr />
<div class="footer-copyright">
<p><span class="copyright">&copy; 2014 Marxon13 Productions (Brandon McQuilkin). All rights reserved. (Last updated: 2014-02-19)</span><br />
<p><span class="copyright">&copy; 2014 Marxon13 Productions (Brandon McQuilkin). All rights reserved. (Last updated: 2014-05-12)</span><br />

<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2 (build 961)</a>.</span></p>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -829,7 +829,7 @@ <h4 class="method-subtitle">Declared In</h4>
<div id="footer">
<hr />
<div class="footer-copyright">
<p><span class="copyright">&copy; 2014 Marxon13 Productions (Brandon McQuilkin). All rights reserved. (Last updated: 2014-02-19)</span><br />
<p><span class="copyright">&copy; 2014 Marxon13 Productions (Brandon McQuilkin). All rights reserved. (Last updated: 2014-05-12)</span><br />

<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2 (build 961)</a>.</span></p>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,8 @@ <h1 class="hideInXcode">M13ProgressHUD Class Reference</h1>

<option value="//api/name/hide:">&nbsp;&nbsp;&nbsp;&nbsp;- hide:</option>

<option value="//api/name/initAndShowWithProgressView:progress:indeterminate:status:mask:inView:">&nbsp;&nbsp;&nbsp;&nbsp;- initAndShowWithProgressView:progress:indeterminate:status:mask:inView:</option>

<option value="//api/name/initWithProgressView:">&nbsp;&nbsp;&nbsp;&nbsp;- initWithProgressView:</option>

<option value="//api/name/isVisible">&nbsp;&nbsp;&nbsp;&nbsp;- isVisible</option>
Expand Down Expand Up @@ -198,6 +200,8 @@ <h1 class="hideInXcode">M13ProgressHUD Class Reference</h1>

<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/hide:">hide:</a></span></li>

<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/initAndShowWithProgressView:progress:indeterminate:status:mask:inView:">initAndShowWithProgressView:progress:indeterminate:status:mask:inView:</a></span></li>

<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/initWithProgressView:">initWithProgressView:</a></span></li>

<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isVisible">isVisible</a></span></li>
Expand Down Expand Up @@ -267,6 +271,12 @@ <h3 class="subsubtitle task-title">Initalization</h3>
</span>


</li><li>
<span class="tooltip">
<code><a href="#//api/name/initAndShowWithProgressView:progress:indeterminate:status:mask:inView:">&ndash;&nbsp;initAndShowWithProgressView:progress:indeterminate:status:mask:inView:</a></code>
</span>


</li>
</ul>

Expand Down Expand Up @@ -1423,6 +1433,82 @@ <h4 class="method-subtitle">Discussion</h4>



<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">M13ProgressHUD.h</code><br />
</div>


</div>

<div class="section-method">
<a name="//api/name/initAndShowWithProgressView:progress:indeterminate:status:mask:inView:" title="initAndShowWithProgressView:progress:indeterminate:status:mask:inView:"></a>
<h3 class="subsubtitle method-title">initAndShowWithProgressView:progress:indeterminate:status:mask:inView:</h3>



<div class="method-subsection brief-description">
<p>Initalize and show the hud with parameters.</p>
</div>



<div class="method-subsection method-declaration"><code>- (id)initAndShowWithProgressView:(M13ProgressView *)<em>progressView</em> progress:(CGFloat)<em>progress</em> indeterminate:(BOOL)<em>indeterminate</em> status:(NSString *)<em>status</em> mask:(M13ProgressHUDMaskType)<em>maskType</em> inView:(UIView *)<em>view</em></code></div>



<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>

<dl class="argument-def parameter-def">
<dt><em>progressView</em></dt>
<dd><p>The <a href="#//api/name/progress">progress</a> view to show in the HUD.</p></dd>
</dl>

<dl class="argument-def parameter-def">
<dt><em>progress</em></dt>
<dd><p>The <a href="#//api/name/progress">progress</a> to display in the <a href="#//api/name/progress">progress</a> view.</p></dd>
</dl>

<dl class="argument-def parameter-def">
<dt><em>indeterminate</em></dt>
<dd><p>Wether or not the <a href="#//api/name/progress">progress</a> view is <a href="#//api/name/indeterminate">indeterminate</a>.</p></dd>
</dl>

<dl class="argument-def parameter-def">
<dt><em>status</em></dt>
<dd><p>The <a href="#//api/name/status">status</a> to display in the HUD.</p></dd>
</dl>

<dl class="argument-def parameter-def">
<dt><em>maskType</em></dt>
<dd><p>The type of mask to use for the HUD.</p></dd>
</dl>

<dl class="argument-def parameter-def">
<dt><em>view</em></dt>
<dd><p>The view to show the HUD in.</p></dd>
</dl>

</div>



<div class="method-subsection return">
<h4 class="method-subtitle parameter-title">Return Value</h4>
<p>A instance of M13PRogressHUD</p>
</div>











<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<code class="declared-in-ref">M13ProgressHUD.h</code><br />
Expand Down Expand Up @@ -1681,7 +1767,7 @@ <h4 class="method-subtitle">Declared In</h4>
<div id="footer">
<hr />
<div class="footer-copyright">
<p><span class="copyright">&copy; 2014 Marxon13 Productions (Brandon McQuilkin). All rights reserved. (Last updated: 2014-02-19)</span><br />
<p><span class="copyright">&copy; 2014 Marxon13 Productions (Brandon McQuilkin). All rights reserved. (Last updated: 2014-05-12)</span><br />

<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2 (build 961)</a>.</span></p>

Expand Down
Loading

0 comments on commit b0367b0

Please sign in to comment.