Permalink
Browse files

Updating documentation

  • Loading branch information...
1 parent 3d85893 commit 786f0718c9495acbe095d9c96524ff68af22b8ed @kgn committed Jul 9, 2011
View
@@ -11,7 +11,7 @@
<string>com.inscopeapps</string>
<key>--input</key>
<array>
- <string>./Spectttator/SPManager.h</string>
+ <string>./Spectttator/SPRequest.h</string>
<string>./Spectttator/SPPagination.h</string>
<string>./Spectttator/SPPlayer.h</string>
<string>./Spectttator/SPShot.h</string>
@@ -143,7 +143,7 @@ <h2 class="subtitle subtitle-overview">Overview</h2>
<pre><code>#import &lt;Spectttator/Spectttator.h&gt;
-[[SPManager sharedManager] shotInformationForIdentifier:199295 runOnMainThread:NO withBlock:^(SPShot *shot){
+[SPRequest shotInformationForIdentifier:199295 runOnMainThread:NO withBlock:^(SPShot *shot){
[shot commentsWithPagination:nil runOnMainThread:NO withBlock:^(NSArray *comments, SPPagination *pagination){
NSLog(@"Comments for '%@': %@", shot.title, comments);
}];
@@ -171,13 +171,13 @@ <h2 class="subtitle subtitle-overview">Overview</h2>
NSString *username = @"inscopeapps";
-[[SPManager sharedManager] shotsForPlayer:user
- withPagination:[SPPagination perPage:20]
- runOnMainThread:NO
- withBlock:^(NSArray *shots, SPPagination *pagination){
- NSLog(@"Received shot data for %@", user);
- NSLog(@"With pagination: %@", pagination);
- }];
+[SPRequest shotsForPlayer:user
+ withPagination:[SPPagination perPage:20]
+ runOnMainThread:NO
+ withBlock:^(NSArray *shots, SPPagination *pagination){
+ NSLog(@"Received shot data for %@", user);
+ NSLog(@"With pagination: %@", pagination);
+ }];
</code></pre>
<p>This is non-blocking, <code>NSLog</code> will run whenever the comment data has finished loading,
@@ -207,11 +207,11 @@ <h2 class="subtitle subtitle-overview">Overview</h2>
NSString *username = @"inscopeapps";
-[[SPManager sharedManager] playerInformationForUsername:username
- runOnMainThread:NO
- withBlock:^(SPPlayer *player){
- NSLog(@"Player information for %@: %@", username, player);
- }];
+[SPRequest playerInformationForUsername:username
+ runOnMainThread:NO
+ withBlock:^(SPPlayer *player){
+ NSLog(@"Player information for %@: %@", username, player);
+ }];
</code></pre>
<p>This is non-blocking, <code>NSLog</code> will run whenever the comment data has finished loading,
@@ -1135,7 +1135,7 @@ <h4 class="method-subtitle parameter-title">Return Value</h4>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>There is no need to call this method directly, it is used by
- higher level methods like <a href="../Classes/SPManager.html#//api/name/playerInformationForUsername:runOnMainThread:withBlock:"><code>[SPManager playerInformationForUsername:runOnMainThread:withBlock:]</code></a>.</p>
+ higher level methods like <a href="../Classes/SPRequest.html#//api/name/playerInformationForUsername:runOnMainThread:withBlock:"><code>[SPRequest playerInformationForUsername:runOnMainThread:withBlock:]</code></a>.</p>
</div>

Large diffs are not rendered by default.

Oops, something went wrong.
@@ -203,7 +203,7 @@ <h2 class="subtitle subtitle-overview">Overview</h2>
<pre><code>#import &lt;Spectttator/Spectttator.h&gt;
-[[SPManager sharedManager] shotInformationForIdentifier:199295 runOnMainThread:NO withBlock:^(SPShot *shot){
+[SPRequest shotInformationForIdentifier:199295 runOnMainThread:NO withBlock:^(SPShot *shot){
NSLog(@"Shot Information: %@", shot);
[shot reboundsWithPagination:nil
runOnMainThread:NO
@@ -1144,7 +1144,7 @@ <h4 class="method-subtitle parameter-title">Return Value</h4>
<h4 class="method-subtitle">Discussion</h4>
<p>There is no need to call this method directly, it is used by
- higher level methods like <a href="../Classes/SPManager.html#//api/name/shotsForList:withPagination:runOnMainThread:withBlock:"><code>[SPManager shotsForList:withPagination:runOnMainThread:withBlock:]</code></a>.</p>
+ higher level methods like <a href="../Classes/SPRequest.html#//api/name/shotsForList:withPagination:runOnMainThread:withBlock:"><code>[SPRequest shotsForList:withPagination:runOnMainThread:withBlock:]</code></a>.</p>
</div>
@@ -29,12 +29,12 @@ <h2 class="index-title">Class Hierarchy</h2>
<li><a href="Classes/SPComment.html">SPComment</a></li>
- <li><a href="Classes/SPManager.html">SPManager</a></li>
-
<li><a href="Classes/SPPagination.html">SPPagination</a></li>
<li><a href="Classes/SPPlayer.html">SPPlayer</a></li>
+ <li><a href="Classes/SPRequest.html">SPRequest</a></li>
+
<li><a href="Classes/SPShot.html">SPShot</a></li>
</ul>
@@ -53,7 +53,7 @@ <h2 class="index-title">Class Hierarchy</h2>
<div id="footer">
<hr />
<div class="footer-copyright">
- <p><span class="copyright">&copy; 2011 David Keegan. All rights reserved. (Last updated: 2011-07-06)</span><br />
+ <p><span class="copyright">&copy; 2011 David Keegan. All rights reserved. (Last updated: 2011-07-08)</span><br />
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.4 (build 703)</a>.</span></p>
View
@@ -27,12 +27,12 @@ <h2 class="index-title">Class References</h2>
<li><a href="Classes/SPComment.html">SPComment</a></li>
- <li><a href="Classes/SPManager.html">SPManager</a></li>
-
<li><a href="Classes/SPPagination.html">SPPagination</a></li>
<li><a href="Classes/SPPlayer.html">SPPlayer</a></li>
+ <li><a href="Classes/SPRequest.html">SPRequest</a></li>
+
<li><a href="Classes/SPShot.html">SPShot</a></li>
</ul>
@@ -47,7 +47,7 @@ <h2 class="index-title">Class References</h2>
<div id="footer">
<hr />
<div class="footer-copyright">
- <p><span class="copyright">&copy; 2011 David Keegan. All rights reserved. (Last updated: 2011-07-06)</span><br />
+ <p><span class="copyright">&copy; 2011 David Keegan. All rights reserved. (Last updated: 2011-07-08)</span><br />
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.4 (build 703)</a>.</span></p>

0 comments on commit 786f071

Please sign in to comment.