Skip to content
Browse files

Updated documentation for release candidate.

  • Loading branch information...
1 parent 1d6c22f commit cf3828f92e7d4e48228dfe21a12b78edab10522e Jim Dovey committed Jul 19, 2011
View
2 Categories/NSIndexSet(AQBitfieldCreation).html
@@ -189,7 +189,7 @@ <h4 class="method-subtitle">Declared In</h4>
<div id="footer">
<hr />
<div class="footer-copyright">
- <p><span class="copyright">&copy; 2011 Jim Dovey. All rights reserved. (Last updated: 2011-06-28)</span><br />
+ <p><span class="copyright">&copy; 2011 Jim Dovey. All rights reserved. (Last updated: 2011-07-19)</span><br />
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.4 (build 702)</a>.</span></p>
View
2 Categories/NSIndexSet(AQRangeMethods).html
@@ -193,7 +193,7 @@ <h4 class="method-subtitle">Declared In</h4>
<div id="footer">
<hr />
<div class="footer-copyright">
- <p><span class="copyright">&copy; 2011 Jim Dovey. All rights reserved. (Last updated: 2011-06-28)</span><br />
+ <p><span class="copyright">&copy; 2011 Jim Dovey. All rights reserved. (Last updated: 2011-07-19)</span><br />
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.4 (build 702)</a>.</span></p>
View
2 Categories/NSPredicate(AQBitfieldPredicates).html
@@ -507,7 +507,7 @@ <h4 class="method-subtitle">Declared In</h4>
<div id="footer">
<hr />
<div class="footer-copyright">
- <p><span class="copyright">&copy; 2011 Jim Dovey. All rights reserved. (Last updated: 2011-06-28)</span><br />
+ <p><span class="copyright">&copy; 2011 Jim Dovey. All rights reserved. (Last updated: 2011-07-19)</span><br />
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.4 (build 702)</a>.</span></p>
View
2,640 Classes/AQAppStateMachine.html
2,612 additions, 28 deletions not shown because the diff is too large. Please use a local Git client to view these changes.
View
258 Classes/AQBitfield.html
@@ -45,8 +45,12 @@ <h1 class="hideInXcode">AQBitfield Class Reference</h1>
<option value="//api/name/bitAtIndex:">&nbsp;&nbsp;&nbsp;&nbsp;- bitAtIndex:</option>
+ <option value="//api/name/bitfieldFromLeftShiftingBy:">&nbsp;&nbsp;&nbsp;&nbsp;- bitfieldFromLeftShiftingBy:</option>
+
<option value="//api/name/bitfieldFromRange:">&nbsp;&nbsp;&nbsp;&nbsp;- bitfieldFromRange:</option>
+ <option value="//api/name/bitfieldFromRightShiftingBy:">&nbsp;&nbsp;&nbsp;&nbsp;- bitfieldFromRightShiftingBy:</option>
+
<option value="//api/name/bitfieldUsingMask:">&nbsp;&nbsp;&nbsp;&nbsp;- bitfieldUsingMask:</option>
<option value="//api/name/bitsInRange:equalToBitfield:">&nbsp;&nbsp;&nbsp;&nbsp;- bitsInRange:equalToBitfield:</option>
@@ -95,6 +99,10 @@ <h1 class="hideInXcode">AQBitfield Class Reference</h1>
<option value="//api/name/setBitsFrom64BitValue:">&nbsp;&nbsp;&nbsp;&nbsp;- setBitsFrom64BitValue:</option>
+ <option value="//api/name/setBitsInRange:from32BitValue:">&nbsp;&nbsp;&nbsp;&nbsp;- setBitsInRange:from32BitValue:</option>
+
+ <option value="//api/name/setBitsInRange:from64BitValue:">&nbsp;&nbsp;&nbsp;&nbsp;- setBitsInRange:from64BitValue:</option>
+
<option value="//api/name/setBitsInRange:usingBit:">&nbsp;&nbsp;&nbsp;&nbsp;- setBitsInRange:usingBit:</option>
<option value="//api/name/shiftBitsLeftBy:">&nbsp;&nbsp;&nbsp;&nbsp;- shiftBitsLeftBy:</option>
@@ -155,8 +163,12 @@ <h1 class="hideInXcode">AQBitfield Class Reference</h1>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/bitAtIndex:">bitAtIndex:</a></span></li>
+ <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/bitfieldFromLeftShiftingBy:">bitfieldFromLeftShiftingBy:</a></span></li>
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/bitfieldFromRange:">bitfieldFromRange:</a></span></li>
+ <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/bitfieldFromRightShiftingBy:">bitfieldFromRightShiftingBy:</a></span></li>
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/bitfieldUsingMask:">bitfieldUsingMask:</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/bitsInRange:equalToBitfield:">bitsInRange:equalToBitfield:</a></span></li>
@@ -205,6 +217,10 @@ <h1 class="hideInXcode">AQBitfield Class Reference</h1>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setBitsFrom64BitValue:">setBitsFrom64BitValue:</a></span></li>
+ <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setBitsInRange:from32BitValue:">setBitsInRange:from32BitValue:</a></span></li>
+
+ <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setBitsInRange:from64BitValue:">setBitsInRange:from64BitValue:</a></span></li>
+
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setBitsInRange:usingBit:">setBitsInRange:usingBit:</a></span></li>
<li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/shiftBitsLeftBy:">shiftBitsLeftBy:</a></span></li>
@@ -460,7 +476,21 @@ <h3 class="subsubtitle task-title">Setting Bits</h3>
</li><li>
<span class="tooltip">
<code><a href="#//api/name/setBitsFrom64BitValue:">&ndash;&nbsp;setBitsFrom64BitValue:</a></code>
- <span class="tooltip"><p>Set the bits in the least-significant four words to those in a 64-bit quantity.</p></span>
+ <span class="tooltip"><p>Set the bits in the least-significant eight words to those in a 64-bit quantity.</p></span>
+ </span>
+
+
+</li><li>
+ <span class="tooltip">
+ <code><a href="#//api/name/setBitsInRange:from32BitValue:">&ndash;&nbsp;setBitsInRange:from32BitValue:</a></code>
+ <span class="tooltip"><p>Set the bits in the given range to those in a 32-bit quantity.</p></span>
+ </span>
+
+
+</li><li>
+ <span class="tooltip">
+ <code><a href="#//api/name/setBitsInRange:from64BitValue:">&ndash;&nbsp;setBitsInRange:from64BitValue:</a></code>
+ <span class="tooltip"><p>Set the bits in the given range to those in a 64-bit quantity.</p></span>
</span>
@@ -542,6 +572,20 @@ <h3 class="subsubtitle task-title">Matching bit values</h3>
</span>
+</li><li>
+ <span class="tooltip">
+ <code><a href="#//api/name/bitfieldFromLeftShiftingBy:">&ndash;&nbsp;bitfieldFromLeftShiftingBy:</a></code>
+ <span class="tooltip"><p>Obtain a bitfield matching the receiver with all bits shifted to the left.</p></span>
+ </span>
+
+
+</li><li>
+ <span class="tooltip">
+ <code><a href="#//api/name/bitfieldFromRightShiftingBy:">&ndash;&nbsp;bitfieldFromRightShiftingBy:</a></code>
+ <span class="tooltip"><p>Obtain a bitfield matching the receiver with all bits shifted to the roght.</p></span>
+ </span>
+
+
</li>
</ul>
@@ -651,6 +695,53 @@ <h4 class="method-subtitle">Declared In</h4>
</div>
<div class="section-method">
+ <a name="//api/name/bitfieldFromLeftShiftingBy:" title="bitfieldFromLeftShiftingBy:"></a>
+ <h3 class="subsubtitle method-title">bitfieldFromLeftShiftingBy:</h3>
+
+
+
+ <div class="method-subsection brief-description">
+ <p>Obtain a bitfield matching the receiver with all bits shifted to the left.</p>
+ </div>
+
+
+ <div class="method-subsection method-declaration"><code>- (AQBitfield *)bitfieldFromLeftShiftingBy:(NSUInteger)<em>bits</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>bits</em></dt>
+ <dd><p>The number of places to shift.</p></dd>
+ </dl>
+
+ </div>
+
+
+
+ <div class="method-subsection return">
+ <h4 class="method-subtitle parameter-title">Return Value</h4>
+ <p>A new bitfield instance.</p>
+ </div>
+
+
+
+
+
+
+
+
+
+ <div class="method-subsection declared-in-section">
+ <h4 class="method-subtitle">Declared In</h4>
+ <code class="declared-in-ref">AQBitfield.h</code><br />
+ </div>
+
+
+</div>
+
+ <div class="section-method">
<a name="//api/name/bitfieldFromRange:" title="bitfieldFromRange:"></a>
<h3 class="subsubtitle method-title">bitfieldFromRange:</h3>
@@ -708,6 +799,53 @@ <h4 class="method-subtitle">Declared In</h4>
</div>
<div class="section-method">
+ <a name="//api/name/bitfieldFromRightShiftingBy:" title="bitfieldFromRightShiftingBy:"></a>
+ <h3 class="subsubtitle method-title">bitfieldFromRightShiftingBy:</h3>
+
+
+
+ <div class="method-subsection brief-description">
+ <p>Obtain a bitfield matching the receiver with all bits shifted to the roght.</p>
+ </div>
+
+
+ <div class="method-subsection method-declaration"><code>- (AQBitfield *)bitfieldFromRightShiftingBy:(NSUInteger)<em>bits</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>bits</em></dt>
+ <dd><p>The number of places to shift.</p></dd>
+ </dl>
+
+ </div>
+
+
+
+ <div class="method-subsection return">
+ <h4 class="method-subtitle parameter-title">Return Value</h4>
+ <p>A new bitfield instance.</p>
+ </div>
+
+
+
+
+
+
+
+
+
+ <div class="method-subsection declared-in-section">
+ <h4 class="method-subtitle">Declared In</h4>
+ <code class="declared-in-ref">AQBitfield.h</code><br />
+ </div>
+
+
+</div>
+
+ <div class="section-method">
<a name="//api/name/bitfieldUsingMask:" title="bitfieldUsingMask:"></a>
<h3 class="subsubtitle method-title">bitfieldUsingMask:</h3>
@@ -1805,7 +1943,7 @@ <h3 class="subsubtitle method-title">setBitsFrom64BitValue:</h3>
<div class="method-subsection brief-description">
- <p>Set the bits in the least-significant four words to those in a 64-bit quantity.</p>
+ <p>Set the bits in the least-significant eight words to those in a 64-bit quantity.</p>
</div>
@@ -1841,6 +1979,120 @@ <h4 class="method-subtitle">Declared In</h4>
</div>
<div class="section-method">
+ <a name="//api/name/setBitsInRange:from32BitValue:" title="setBitsInRange:from32BitValue:"></a>
+ <h3 class="subsubtitle method-title">setBitsInRange:from32BitValue:</h3>
+
+
+
+ <div class="method-subsection brief-description">
+ <p>Set the bits in the given range to those in a 32-bit quantity.</p>
+ </div>
+
+
+ <div class="method-subsection method-declaration"><code>- (void)setBitsInRange:(NSRange)<em>range</em> from32BitValue:(UInt32)<em>value</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>range</em></dt>
+ <dd><p>The range of bits to modify.</p></dd>
+ </dl>
+
+ <dl class="argument-def parameter-def">
+ <dt><em>value</em></dt>
+ <dd><p>The value whose bits to copy.</p></dd>
+ </dl>
+
+ </div>
+
+
+
+
+
+
+
+ <div class="method-subsection arguments-section exceptions">
+ <h4 class="method-subtitle exception-title">Exceptions</h4>
+
+ <dl class="argument-def exception-def">
+ <dt><em>NSInvalidArgumentException</em></dt>
+ <dd><p>Thrown if the supplied range is greater than 32 bits in length.</p></dd>
+ </dl>
+
+ </div>
+
+
+
+
+
+ <div class="method-subsection declared-in-section">
+ <h4 class="method-subtitle">Declared In</h4>
+ <code class="declared-in-ref">AQBitfield.h</code><br />
+ </div>
+
+
+</div>
+
+ <div class="section-method">
+ <a name="//api/name/setBitsInRange:from64BitValue:" title="setBitsInRange:from64BitValue:"></a>
+ <h3 class="subsubtitle method-title">setBitsInRange:from64BitValue:</h3>
+
+
+
+ <div class="method-subsection brief-description">
+ <p>Set the bits in the given range to those in a 64-bit quantity.</p>
+ </div>
+
+
+ <div class="method-subsection method-declaration"><code>- (void)setBitsInRange:(NSRange)<em>range</em> from64BitValue:(UInt64)<em>value</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>range</em></dt>
+ <dd><p>The range of bits to modify.</p></dd>
+ </dl>
+
+ <dl class="argument-def parameter-def">
+ <dt><em>value</em></dt>
+ <dd><p>The value whose bits to copy.</p></dd>
+ </dl>
+
+ </div>
+
+
+
+
+
+
+
+ <div class="method-subsection arguments-section exceptions">
+ <h4 class="method-subtitle exception-title">Exceptions</h4>
+
+ <dl class="argument-def exception-def">
+ <dt><em>NSInvalidArgumentException</em></dt>
+ <dd><p>Thrown if the supplied range is greater than 64 bits in length.</p></dd>
+ </dl>
+
+ </div>
+
+
+
+
+
+ <div class="method-subsection declared-in-section">
+ <h4 class="method-subtitle">Declared In</h4>
+ <code class="declared-in-ref">AQBitfield.h</code><br />
+ </div>
+
+
+</div>
+
+ <div class="section-method">
<a name="//api/name/setBitsInRange:usingBit:" title="setBitsInRange:usingBit:"></a>
<h3 class="subsubtitle method-title">setBitsInRange:usingBit:</h3>
@@ -2026,7 +2278,7 @@ <h4 class="method-subtitle">Declared In</h4>
<div id="footer">
<hr />
<div class="footer-copyright">
- <p><span class="copyright">&copy; 2011 Jim Dovey. All rights reserved. (Last updated: 2011-06-28)</span><br />
+ <p><span class="copyright">&copy; 2011 Jim Dovey. All rights reserved. (Last updated: 2011-07-19)</span><br />
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.4 (build 702)</a>.</span></p>
View
2 Classes/AQNotifyingBitfield.html
@@ -316,7 +316,7 @@ <h4 class="method-subtitle">Declared In</h4>
<div id="footer">
<hr />
<div class="footer-copyright">
- <p><span class="copyright">&copy; 2011 Jim Dovey. All rights reserved. (Last updated: 2011-06-28)</span><br />
+ <p><span class="copyright">&copy; 2011 Jim Dovey. All rights reserved. (Last updated: 2011-07-19)</span><br />
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.4 (build 702)</a>.</span></p>
View
2 Classes/AQRange.html
@@ -503,7 +503,7 @@ <h4 class="method-subtitle">Declared In</h4>
<div id="footer">
<hr />
<div class="footer-copyright">
- <p><span class="copyright">&copy; 2011 Jim Dovey. All rights reserved. (Last updated: 2011-06-28)</span><br />
+ <p><span class="copyright">&copy; 2011 Jim Dovey. All rights reserved. (Last updated: 2011-07-19)</span><br />
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.4 (build 702)</a>.</span></p>
View
2 Classes/AQStateMaskMatchingDescriptor.html
@@ -418,7 +418,7 @@ <h4 class="method-subtitle">Declared In</h4>
<div id="footer">
<hr />
<div class="footer-copyright">
- <p><span class="copyright">&copy; 2011 Jim Dovey. All rights reserved. (Last updated: 2011-06-28)</span><br />
+ <p><span class="copyright">&copy; 2011 Jim Dovey. All rights reserved. (Last updated: 2011-07-19)</span><br />
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.4 (build 702)</a>.</span></p>
View
12 Classes/AQStateMaskedEqualityMatchingDescriptor.html
@@ -360,6 +360,11 @@ <h3 class="subsubtitle method-title">initWith32BitValue:forRange:matchingMask:</
<h4 class="method-subtitle parameter-title">Parameters</h4>
<dl class="argument-def parameter-def">
+ <dt><em>value</em></dt>
+ <dd><p>A value specifying the exact bits within the range to match. Can be zero.</p></dd>
+ </dl>
+
+ <dl class="argument-def parameter-def">
<dt><em>range</em></dt>
<dd><p>The range to match.</p></dd>
</dl>
@@ -464,6 +469,11 @@ <h3 class="subsubtitle method-title">initWith64BitValue:forRange:matchingMask:</
<h4 class="method-subtitle parameter-title">Parameters</h4>
<dl class="argument-def parameter-def">
+ <dt><em>value</em></dt>
+ <dd><p>A value specifying the exact bits within the range to match. Can be zero.</p></dd>
+ </dl>
+
+ <dl class="argument-def parameter-def">
<dt><em>range</em></dt>
<dd><p>The range to match.</p></dd>
</dl>
@@ -730,7 +740,7 @@ <h4 class="method-subtitle">Declared In</h4>
<div id="footer">
<hr />
<div class="footer-copyright">
- <p><span class="copyright">&copy; 2011 Jim Dovey. All rights reserved. (Last updated: 2011-06-28)</span><br />
+ <p><span class="copyright">&copy; 2011 Jim Dovey. All rights reserved. (Last updated: 2011-07-19)</span><br />
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.4 (build 702)</a>.</span></p>
View
2 Classes/AQStateMatchingDescriptor.html
@@ -488,7 +488,7 @@ <h4 class="method-subtitle">Declared In</h4>
<div id="footer">
<hr />
<div class="footer-copyright">
- <p><span class="copyright">&copy; 2011 Jim Dovey. All rights reserved. (Last updated: 2011-06-28)</span><br />
+ <p><span class="copyright">&copy; 2011 Jim Dovey. All rights reserved. (Last updated: 2011-07-19)</span><br />
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.4 (build 702)</a>.</span></p>
View
2 hierarchy.html
@@ -85,7 +85,7 @@ <h2 class="index-title">Category References</h2>
<div id="footer">
<hr />
<div class="footer-copyright">
- <p><span class="copyright">&copy; 2011 Jim Dovey. All rights reserved. (Last updated: 2011-06-28)</span><br />
+ <p><span class="copyright">&copy; 2011 Jim Dovey. All rights reserved. (Last updated: 2011-07-19)</span><br />
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.4 (build 702)</a>.</span></p>
View
2 index.html
@@ -67,7 +67,7 @@ <h2 class="index-title">Category References</h2>
<div id="footer">
<hr />
<div class="footer-copyright">
- <p><span class="copyright">&copy; 2011 Jim Dovey. All rights reserved. (Last updated: 2011-06-28)</span><br />
+ <p><span class="copyright">&copy; 2011 Jim Dovey. All rights reserved. (Last updated: 2011-07-19)</span><br />
<span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.4 (build 702)</a>.</span></p>
View
BIN net.alanquatermain.AQAppStateMachine-0.1.xar
Binary file not shown.
View
12 net.alanquatermain.AQAppStateMachine.atom
@@ -1,18 +1,18 @@
-<?xml version="1.0"?>
+<?xml version="1.0" standalone="no"?>
<feed xmlns="http://www.w3.org/2005/Atom" xmlns:docset="http://developer.apple.com/rss/docset_extensions" xml:lang="en">
- <id>http://alanquatermain.github.com/AQAppStateMachine/net.alanquatermain.AQAppStateMachine.atom/20110628165122</id>
+ <id>http://alanquatermain.github.com/AQAppStateMachine/net.alanquatermain.AQAppStateMachine.atom/20110719114453</id>
<title type="text">AQAppStateMachine Documentation</title>
<rights>Copyright © 2011 Jim Dovey. All rights reserved.</rights>
<link rel="self" href="http://alanquatermain.github.com/AQAppStateMachine/net.alanquatermain.AQAppStateMachine.atom"></link>
<docset:publisherName>Jim Dovey</docset:publisherName>
<docset:publisherID>net.alanquatermain.documentation</docset:publisherID>
- <updated>2011-06-28T16:51:22-04:00</updated>
+ <updated>2011-07-19T11:44:53-04:00</updated>
<entry>
- <id>tag:alanquatermain.github.com,2011-06-28:net.alanquatermain.AQAppStateMachine/0.1.0</id>
+ <id>tag:alanquatermain.github.com,2011-07-19:net.alanquatermain.AQAppStateMachine/0.1.0</id>
<title type="text">AQAppStateMachine Documentation</title>
- <updated>2011-06-28T16:51:22-04:00</updated>
+ <updated>2011-07-19T11:44:53-04:00</updated>
<content type="text">AQAppStateMachine Documentation (v0.1.0)</content>
- <link rel="enclosure" type="application/octet-stream" href="http://alanquatermain.github.com/AQAppStateMachine/net.alanquatermain.AQAppStateMachine-0.1.xar" length="78361"></link>
+ <link rel="enclosure" type="application/octet-stream" href="http://alanquatermain.github.com/AQAppStateMachine/net.alanquatermain.AQAppStateMachine-0.1.xar" length="95293"></link>
<docset:identifier>net.alanquatermain.AQAppStateMachine</docset:identifier>
<docset:version>0.1.0</docset:version>
<docset:minimumXcodeVersion>3.0.0</docset:minimumXcodeVersion>

0 comments on commit cf3828f

Please sign in to comment.
Something went wrong with that request. Please try again.