Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Update documentation.

  • Loading branch information...
commit ea3e3bd273ae881d2d0c97956a8c6aa851e5f1e4 1 parent 11ffba5
@danielctull authored
View
123 Documentation/Classes/DTResurrectionController.html
@@ -43,6 +43,34 @@ <h2 class="subtitle subtitle-overview">Overview</h2>
+ <div class="section section-tasks">
+ <h2 class="subtitle subtitle-tasks">Tasks</h2>
+
+
+
+ <ul class="task-list">
+ <li>
+ <span class="tooltip">
+ <code><a href="#//api/name/hasResurrected"> hasResurrected</a></code>
+
+ </span>
+
+</li><li>
+ <span class="tooltip">
+ <code><a href="#//api/name/debugMode"> debugMode</a></code>
+
+ </span>
+
+</li><li>
+ <span class="tooltip">
+ <code><a href="#//api/name/resurrectWithArchivePath:">- resurrectWithArchivePath:</a></code>
+
+ </span>
+
+</li>
+ </ul>
+
+ </div>
@@ -50,6 +78,101 @@ <h2 class="subtitle subtitle-overview">Overview</h2>
+ <div class="section section-methods">
+ <h2 class="subtitle subtitle-methods">Instance Methods</h2>
+
+ <div class="section-method">
+ <a name="//api/name/resurrectWithArchivePath:" title="resurrectWithArchivePath:"></a>
+ <h3 class="subsubtitle method-title">resurrectWithArchivePath:</h3>
+
+
+
+
+ <div class="method-subsection method-declaration"><code>- (void)resurrectWithArchivePath:(NSString *)<em>path</em></code></div>
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="method-subsection declared-in-section">
+ <h4 class="method-subtitle">Declared In</h4>
+ <code class="declared-in-ref">DTResurrectionController.h</code><br />
+ </div>
+
+
+</div>
+
+ </div>
+
+
+
+ <div class="section section-methods">
+ <h2 class="subtitle subtitle-methods">Properties</h2>
+
+ <div class="section-method">
+ <a name="//api/name/debugMode" title="debugMode"></a>
+ <h3 class="subsubtitle method-title">debugMode</h3>
+
+
+
+
+ <div class="method-subsection method-declaration"><code>@property (nonatomic, assign) BOOL debugMode</code></div>
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="method-subsection declared-in-section">
+ <h4 class="method-subtitle">Declared In</h4>
+ <code class="declared-in-ref">DTResurrectionController.h</code><br />
+ </div>
+
+
+</div>
+
+ <div class="section-method">
+ <a name="//api/name/hasResurrected" title="hasResurrected"></a>
+ <h3 class="subsubtitle method-title">hasResurrected</h3>
+
+
+
+
+ <div class="method-subsection method-declaration"><code>@property (nonatomic, assign) BOOL hasResurrected</code></div>
+
+
+
+
+
+
+
+
+
+
+
+
+ <div class="method-subsection declared-in-section">
+ <h4 class="method-subtitle">Declared In</h4>
+ <code class="declared-in-ref">DTResurrectionController.h</code><br />
+ </div>
+
+
+</div>
+
+ </div>
</div>
View
100 Documentation/Classes/DTResurrector.html
@@ -50,13 +50,25 @@ <h2 class="subtitle subtitle-overview">Overview</h2>
<div class="section section-tasks">
<h2 class="subtitle subtitle-tasks">Tasks</h2>
- <h3 class="subsubtitle task-title">Convert graph hierarchy @{</h3>
+ <h3 class="subsubtitle task-title">Other Methods</h3>
+
+ <ul class="task-list">
+ <li>
+ <span class="tooltip">
+ <code><a href="#//api/name/objectIsCoreObject:">- objectIsCoreObject:</a></code>
+ <span class="tooltip"> Used to test if an the given object is a core object within resurrection kit. </span>
+ </span>
+
+</li>
+ </ul>
+
+ <h3 class="subsubtitle task-title">Convert graph hierarchy</h3>
<ul class="task-list">
<li>
<span class="tooltip">
<code><a href="#//api/name/deconstructWithRootObject:">- deconstructWithRootObject:</a></code>
- <span class="tooltip"> @brief Encodes the graph hierarchy starting at the given object. </span>
+ <span class="tooltip"> Encodes the graph hierarchy starting at the given object. </span>
</span>
</li><li>
@@ -68,19 +80,19 @@ <h3 class="subsubtitle task-title">Convert graph hierarchy @{</h3>
</li>
</ul>
- <h3 class="subsubtitle task-title">Storing values @{</h3>
+ <h3 class="subsubtitle task-title">Storing values</h3>
<ul class="task-list">
<li>
<span class="tooltip">
<code><a href="#//api/name/setObject:forKey:">- setObject:forKey:</a></code>
- <span class="tooltip"> @brief Use to save metadata about the object. </span>
+ <span class="tooltip"> Use to save metadata about the object. </span>
</span>
</li><li>
<span class="tooltip">
<code><a href="#//api/name/objectForKey:">- objectForKey:</a></code>
- <span class="tooltip"> @brief Use to retrive metadata about the object. </span>
+ <span class="tooltip"> Use to retrive metadata about the object. </span>
</span>
</li>
@@ -104,7 +116,7 @@ <h3 class="subsubtitle method-title">deconstructWithRootObject:</h3>
<div class="method-subsection brief-description">
- <p> @brief Encodes the graph hierarchy starting at the given object. </p>
+ <p> Encodes the graph hierarchy starting at the given object. </p>
</div>
@@ -116,13 +128,18 @@ <h4 class="method-subtitle parameter-title">Parameters</h4>
<dl class="argument-def parameter-def">
<dt><em>object</em></dt>
- <dd> The root object of the graph. return A dictionary representing the object graph. </dd>
+ <dd> The root object of the graph. </dd>
</dl>
</div>
+ <div class="method-subsection return">
+ <h4 class="method-subtitle parameter-title">Return Value</h4>
+ <p> A dictionary representing the object graph. </p>
+ </div>
+
@@ -146,7 +163,7 @@ <h3 class="subsubtitle method-title">objectForKey:</h3>
<div class="method-subsection brief-description">
- <p> @brief Use to retrive metadata about the object. </p>
+ <p> Use to retrive metadata about the object. </p>
</div>
@@ -182,6 +199,64 @@ <h4 class="method-subtitle">Declared In</h4>
</div>
<div class="section-method">
+ <a name="//api/name/objectIsCoreObject:" title="objectIsCoreObject:"></a>
+ <h3 class="subsubtitle method-title">objectIsCoreObject:</h3>
+
+
+
+ <div class="method-subsection brief-description">
+ <p> Used to test if an the given object is a core object within resurrection kit. </p>
+ </div>
+
+
+ <div class="method-subsection method-declaration"><code>- (BOOL)objectIsCoreObject:(id)<em>object</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>object</em></dt>
+ <dd> The object to test. </dd>
+ </dl>
+
+ </div>
+
+
+
+ <div class="method-subsection return">
+ <h4 class="method-subtitle parameter-title">Return Value</h4>
+ <p> YES if the object is a core object, NO if not. </p>
+ </div>
+
+
+
+ <div class="method-subsection discussion-section">
+ <h4 class="method-subtitle">Discussion</h4>
+
+ <p> Used to test if an the given object is a core object within resurrection kit. </p>
+
+ <p> Core objects in the system are currently members of the classes NSNumber, NSString, NSData and NSDate. If you want to store any other type of object, you will need to implement the initWithResurrector: and encodeToResurrector: methods from the <a href="../Protocols/DTResurrection.html">DTResurrection</a> protocol. </p>
+
+ <p> The reason the list of core objects is not the same as any object that conforms to NSCoding is that the resurrection system keeps a reference of the objects it is saving, and if it comes across the same object again, it won&apos;t need to query it again, and instead will use the existing refernce. </p>
+
+ </div>
+
+
+
+
+
+
+
+ <div class="method-subsection declared-in-section">
+ <h4 class="method-subtitle">Declared In</h4>
+ <code class="declared-in-ref">DTResurrector.h</code><br />
+ </div>
+
+
+</div>
+
+ <div class="section-method">
<a name="//api/name/resurrect:" title="resurrect:"></a>
<h3 class="subsubtitle method-title">resurrect:</h3>
@@ -200,13 +275,18 @@ <h4 class="method-subtitle parameter-title">Parameters</h4>
<dl class="argument-def parameter-def">
<dt><em>dictionary</em></dt>
- <dd> A dictionary representing the object graph. return The root object of the graph. </dd>
+ <dd> A dictionary representing the object graph. </dd>
</dl>
</div>
+ <div class="method-subsection return">
+ <h4 class="method-subtitle parameter-title">Return Value</h4>
+ <p> The root object of the graph. </p>
+ </div>
+
@@ -230,7 +310,7 @@ <h3 class="subsubtitle method-title">setObject:forKey:</h3>
<div class="method-subsection brief-description">
- <p> @brief Use to save metadata about the object. </p>
+ <p> Use to save metadata about the object. </p>
</div>
View
10 Documentation/Protocols/DTResurrection.html
@@ -49,13 +49,13 @@ <h2 class="subtitle subtitle-tasks">Tasks</h2>
<li>
<span class="tooltip">
<code><a href="#//api/name/initWithResurrector:">- initWithResurrector:</a></code>
- <span class="tooltip"> @brief Initialiser DTResurrectionKit uses to restore the object. </span>
+ <span class="tooltip"> Initialiser DTResurrectionKit uses to restore the object. </span>
</span>
<span class="task-item-suffix">required method</span>
</li><li>
<span class="tooltip">
<code><a href="#//api/name/encodeToResurrector:">- encodeToResurrector:</a></code>
- <span class="tooltip"> @brief Method DTResurrectionKit uses to save the object metadata. </span>
+ <span class="tooltip"> Method DTResurrectionKit uses to save the object metadata. </span>
</span>
<span class="task-item-suffix">required method</span>
</li>
@@ -79,7 +79,7 @@ <h3 class="subsubtitle method-title">encodeToResurrector:</h3>
<div class="method-subsection brief-description">
- <p> @brief Method DTResurrectionKit uses to save the object metadata. </p>
+ <p> Method DTResurrectionKit uses to save the object metadata. </p>
</div>
@@ -121,7 +121,7 @@ <h3 class="subsubtitle method-title">initWithResurrector:</h3>
<div class="method-subsection brief-description">
- <p> @brief Initialiser DTResurrectionKit uses to restore the object. </p>
+ <p> Initialiser DTResurrectionKit uses to restore the object. </p>
</div>
@@ -145,7 +145,7 @@ <h4 class="method-subtitle parameter-title">Parameters</h4>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
- <p> @brief Initialiser DTResurrectionKit uses to restore the object. </p>
+ <p> Initialiser DTResurrectionKit uses to restore the object. </p>
<p> As shown in DTResurrector, you can save </p>
Please sign in to comment.
Something went wrong with that request. Please try again.