ForwardReferencing.html in eymiha_util-1.0.2

- old
+ new
@@ -1,320 +1,320 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html 
-     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-  <title>Module: Eymiha::ForwardReferencing</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
-  <script type="text/javascript">
-  // <![CDATA[
-
-  function popupCode( url ) {
-    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
-  }
-
-  function toggleCode( id ) {
-    if ( document.getElementById )
-      elem = document.getElementById( id );
-    else if ( document.all )
-      elem = eval( "document.all." + id );
-    else
-      return false;
-
-    elemStyle = elem.style;
-    
-    if ( elemStyle.display != "block" ) {
-      elemStyle.display = "block"
-    } else {
-      elemStyle.display = "none"
-    }
-
-    return true;
-  }
-  
-  // Make codeblocks hidden by default
-  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-  
-  // ]]>
-  </script>
-
-</head>
-<body>
-
-
-
-    <div id="classHeader">
-        <table class="header-table">
-        <tr class="top-aligned-row">
-          <td><strong>Module</strong></td>
-          <td class="class-name-in-header">Eymiha::ForwardReferencing</td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>In:</strong></td>
-            <td>
-                <a href="../../files/lib/eymiha/util/forward_referencing_rb.html">
-                lib/eymiha/util/forward_referencing.rb
-                </a>
-        <br />
-            </td>
-        </tr>
-
-        </table>
-    </div>
-  <!-- banner header -->
-
-  <div id="bodyContent">
-
-
-
-  <div id="contextContent">
-
-    <div id="description">
-      <p>
-The <a href="ForwardReferencing.html">ForwardReferencing</a> module can be
-mixed into a class to allow it to capture and resolve ForwardReferences.
-</p>
-
-    </div>
-
-
-   </div>
-
-    <div id="method-list">
-      <h3 class="section-bar">Methods</h3>
-
-      <div class="name-list">
-      <a href="#M000009">continue_forward_reference_resolution</a>&nbsp;&nbsp;
-      <a href="#M000006">create_forward_reference</a>&nbsp;&nbsp;
-      <a href="#M000010">forward_reference_dependencies</a>&nbsp;&nbsp;
-      <a href="#M000013">forward_references_clear</a>&nbsp;&nbsp;
-      <a href="#M000012">forward_references_remaining</a>&nbsp;&nbsp;
-      <a href="#M000011">forward_references_to_s</a>&nbsp;&nbsp;
-      <a href="#M000007">remove_forward_reference</a>&nbsp;&nbsp;
-      <a href="#M000008">resolve_forward_references</a>&nbsp;&nbsp;
-      <a href="#M000005">start_forward_referencing</a>&nbsp;&nbsp;
-      </div>
-    </div>
-
-  </div>
-
-
-    <!-- if includes -->
-
-    <div id="section">
-
-
-
-
-
-    <div id="attribute-list">
-      <h3 class="section-bar">Attributes</h3>
-
-      <div class="name-list">
-        <table>
-        <tr class="top-aligned-row context-row">
-          <td class="context-item-name">forward_references</td>
-          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
-          <td class="context-item-desc">
-An array containing the set of unresolved forward references.
-
-</td>
-        </tr>
-        </table>
-      </div>
-    </div>
-      
-
-
-    <!-- if method_list -->
-    <div id="methods">
-      <h3 class="section-bar">Public Instance methods</h3>
-
-      <div id="method-M000009" class="method-detail">
-        <a name="M000009"></a>
-
-        <div class="method-heading">
-          <a href="ForwardReferencing.src/M000009.html" target="Code" class="method-signature"
-            onclick="popupCode('ForwardReferencing.src/M000009.html');return false;">
-          <span class="method-name">continue_forward_reference_resolution</span><span class="method-args">()</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-To be called at the end of a section of code that could contain a forward
-reference, it will continue during normal processing and jump back to the
-<a href="ForwardReferencing.html#M000008">resolve_forward_references</a>
-method during resolution.
-</p>
-        </div>
-      </div>
-
-      <div id="method-M000006" class="method-detail">
-        <a name="M000006"></a>
-
-        <div class="method-heading">
-          <a href="ForwardReferencing.src/M000006.html" target="Code" class="method-signature"
-            onclick="popupCode('ForwardReferencing.src/M000006.html');return false;">
-          <span class="method-name">create_forward_reference</span><span class="method-args">(dependency=nil,context=nil)</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-To be called when a section of code that could contain a forward reference
-is entered. The method returns a newly created <a
-href="ForwardReference.html">ForwardReference</a> with the given dependency
-that can be jumped to during resolution.
-</p>
-        </div>
-      </div>
-
-      <div id="method-M000010" class="method-detail">
-        <a name="M000010"></a>
-
-        <div class="method-heading">
-          <a href="ForwardReferencing.src/M000010.html" target="Code" class="method-signature"
-            onclick="popupCode('ForwardReferencing.src/M000010.html');return false;">
-          <span class="method-name">forward_reference_dependencies</span><span class="method-args">()</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-Returns a hash of dependencies to arrays of the ForwardReferences that have
-them as dependencies.
-</p>
-        </div>
-      </div>
-
-      <div id="method-M000013" class="method-detail">
-        <a name="M000013"></a>
-
-        <div class="method-heading">
-          <a href="ForwardReferencing.src/M000013.html" target="Code" class="method-signature"
-            onclick="popupCode('ForwardReferencing.src/M000013.html');return false;">
-          <span class="method-name">forward_references_clear</span><span class="method-args">()</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-Remove the remaining unresolved forward references.
-</p>
-        </div>
-      </div>
-
-      <div id="method-M000012" class="method-detail">
-        <a name="M000012"></a>
-
-        <div class="method-heading">
-          <a href="ForwardReferencing.src/M000012.html" target="Code" class="method-signature"
-            onclick="popupCode('ForwardReferencing.src/M000012.html');return false;">
-          <span class="method-name">forward_references_remaining</span><span class="method-args">()</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-Returns the number of unresolved forward references.
-</p>
-        </div>
-      </div>
-
-      <div id="method-M000011" class="method-detail">
-        <a name="M000011"></a>
-
-        <div class="method-heading">
-          <a href="ForwardReferencing.src/M000011.html" target="Code" class="method-signature"
-            onclick="popupCode('ForwardReferencing.src/M000011.html');return false;">
-          <span class="method-name">forward_references_to_s</span><span class="method-args">()</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-Returns a string indicating the current state of <a
-href="ForwardReferencing.html">ForwardReferencing</a>.
-</p>
-        </div>
-      </div>
-
-      <div id="method-M000007" class="method-detail">
-        <a name="M000007"></a>
-
-        <div class="method-heading">
-          <a href="ForwardReferencing.src/M000007.html" target="Code" class="method-signature"
-            onclick="popupCode('ForwardReferencing.src/M000007.html');return false;">
-          <span class="method-name">remove_forward_reference</span><span class="method-args">(forward_reference=nil)</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-To be called when a section of code that could contain a forward reference
-has successfully been reached. It is used to remove the <a
-href="ForwardReference.html">ForwardReference</a> that was created at the
-start of the section, and asserts that a resolution was made.
-</p>
-        </div>
-      </div>
-
-      <div id="method-M000008" class="method-detail">
-        <a name="M000008"></a>
-
-        <div class="method-heading">
-          <a href="ForwardReferencing.src/M000008.html" target="Code" class="method-signature"
-            onclick="popupCode('ForwardReferencing.src/M000008.html');return false;">
-          <span class="method-name">resolve_forward_references</span><span class="method-args">()</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-To be called to try to resolve any unresolved ForwardReferences by jumping
-to each in turn and retrying the code that caused it. This method repeats
-until nothing more is resolved. At that point unresolved forward reference
-may still exist, to be possibly resolved by another call to this method
-downstream. Prior to continuing to a forward reference, the
-establish_forward_reference context method is called with the context that
-was provided at the time the forward reference was created to give the
-receiver a chance to reset any transcient infromation.
-</p>
-        </div>
-      </div>
-
-      <div id="method-M000005" class="method-detail">
-        <a name="M000005"></a>
-
-        <div class="method-heading">
-          <a href="ForwardReferencing.src/M000005.html" target="Code" class="method-signature"
-            onclick="popupCode('ForwardReferencing.src/M000005.html');return false;">
-          <span class="method-name">start_forward_referencing</span><span class="method-args">()</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-          <p>
-To be called from the initializer of the includer, this sets up the forward
-reference capture and resolution mechanisms.
-</p>
-        </div>
-      </div>
-
-
-    </div>
-
-
-  </div>
-
-
-<div id="validator-badges">
-  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Module: Eymiha::ForwardReferencing</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">Eymiha::ForwardReferencing</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/eymiha/util/forward_referencing_rb.html">
+                lib/eymiha/util/forward_referencing.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+    <div id="description">
+      <p>
+The <a href="ForwardReferencing.html">ForwardReferencing</a> module can be
+mixed into a class to allow it to capture and resolve ForwardReferences.
+</p>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000010">continue_forward_reference_resolution</a>&nbsp;&nbsp;
+      <a href="#M000007">create_forward_reference</a>&nbsp;&nbsp;
+      <a href="#M000011">forward_reference_dependencies</a>&nbsp;&nbsp;
+      <a href="#M000014">forward_references_clear</a>&nbsp;&nbsp;
+      <a href="#M000013">forward_references_remaining</a>&nbsp;&nbsp;
+      <a href="#M000012">forward_references_to_s</a>&nbsp;&nbsp;
+      <a href="#M000008">remove_forward_reference</a>&nbsp;&nbsp;
+      <a href="#M000009">resolve_forward_references</a>&nbsp;&nbsp;
+      <a href="#M000006">start_forward_referencing</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+    <div id="attribute-list">
+      <h3 class="section-bar">Attributes</h3>
+
+      <div class="name-list">
+        <table>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">forward_references</td>
+          <td class="context-item-value">&nbsp;[R]&nbsp;</td>
+          <td class="context-item-desc">
+An array containing the set of unresolved forward references.
+
+</td>
+        </tr>
+        </table>
+      </div>
+    </div>
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000010" class="method-detail">
+        <a name="M000010"></a>
+
+        <div class="method-heading">
+          <a href="ForwardReferencing.src/M000010.html" target="Code" class="method-signature"
+            onclick="popupCode('ForwardReferencing.src/M000010.html');return false;">
+          <span class="method-name">continue_forward_reference_resolution</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+To be called at the end of a section of code that could contain a forward
+reference, it will continue during normal processing and jump back to the
+<a href="ForwardReferencing.html#M000009">resolve_forward_references</a>
+method during resolution.
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000007" class="method-detail">
+        <a name="M000007"></a>
+
+        <div class="method-heading">
+          <a href="ForwardReferencing.src/M000007.html" target="Code" class="method-signature"
+            onclick="popupCode('ForwardReferencing.src/M000007.html');return false;">
+          <span class="method-name">create_forward_reference</span><span class="method-args">(dependency=nil,context=nil)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+To be called when a section of code that could contain a forward reference
+is entered. The method returns a newly created <a
+href="ForwardReference.html">ForwardReference</a> with the given dependency
+that can be jumped to during resolution.
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000011" class="method-detail">
+        <a name="M000011"></a>
+
+        <div class="method-heading">
+          <a href="ForwardReferencing.src/M000011.html" target="Code" class="method-signature"
+            onclick="popupCode('ForwardReferencing.src/M000011.html');return false;">
+          <span class="method-name">forward_reference_dependencies</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Returns a hash of dependencies to arrays of the ForwardReferences that have
+them as dependencies.
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000014" class="method-detail">
+        <a name="M000014"></a>
+
+        <div class="method-heading">
+          <a href="ForwardReferencing.src/M000014.html" target="Code" class="method-signature"
+            onclick="popupCode('ForwardReferencing.src/M000014.html');return false;">
+          <span class="method-name">forward_references_clear</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Remove the remaining unresolved forward references.
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000013" class="method-detail">
+        <a name="M000013"></a>
+
+        <div class="method-heading">
+          <a href="ForwardReferencing.src/M000013.html" target="Code" class="method-signature"
+            onclick="popupCode('ForwardReferencing.src/M000013.html');return false;">
+          <span class="method-name">forward_references_remaining</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Returns the number of unresolved forward references.
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000012" class="method-detail">
+        <a name="M000012"></a>
+
+        <div class="method-heading">
+          <a href="ForwardReferencing.src/M000012.html" target="Code" class="method-signature"
+            onclick="popupCode('ForwardReferencing.src/M000012.html');return false;">
+          <span class="method-name">forward_references_to_s</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Returns a string indicating the current state of <a
+href="ForwardReferencing.html">ForwardReferencing</a>.
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000008" class="method-detail">
+        <a name="M000008"></a>
+
+        <div class="method-heading">
+          <a href="ForwardReferencing.src/M000008.html" target="Code" class="method-signature"
+            onclick="popupCode('ForwardReferencing.src/M000008.html');return false;">
+          <span class="method-name">remove_forward_reference</span><span class="method-args">(forward_reference=nil)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+To be called when a section of code that could contain a forward reference
+has successfully been reached. It is used to remove the <a
+href="ForwardReference.html">ForwardReference</a> that was created at the
+start of the section, and asserts that a resolution was made.
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000009" class="method-detail">
+        <a name="M000009"></a>
+
+        <div class="method-heading">
+          <a href="ForwardReferencing.src/M000009.html" target="Code" class="method-signature"
+            onclick="popupCode('ForwardReferencing.src/M000009.html');return false;">
+          <span class="method-name">resolve_forward_references</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+To be called to try to resolve any unresolved ForwardReferences by jumping
+to each in turn and retrying the code that caused it. This method repeats
+until nothing more is resolved. At that point unresolved forward reference
+may still exist, to be possibly resolved by another call to this method
+downstream. Prior to continuing to a forward reference, the
+establish_forward_reference context method is called with the context that
+was provided at the time the forward reference was created to give the
+receiver a chance to reset any transcient infromation.
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000006" class="method-detail">
+        <a name="M000006"></a>
+
+        <div class="method-heading">
+          <a href="ForwardReferencing.src/M000006.html" target="Code" class="method-signature"
+            onclick="popupCode('ForwardReferencing.src/M000006.html');return false;">
+          <span class="method-name">start_forward_referencing</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+To be called from the initializer of the includer, this sets up the forward
+reference capture and resolution mechanisms.
+</p>
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
 </html>
\ No newline at end of file