Skip to content

Commit

Permalink
Remade the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Anthony Short committed Jul 18, 2010
1 parent 15e3856 commit c07a49e
Show file tree
Hide file tree
Showing 46 changed files with 1,042 additions and 468 deletions.
22 changes: 11 additions & 11 deletions docs/Environment/Environment.html
View file
Expand Up @@ -124,7 +124,7 @@ <h2 class="class-name">Class Environment</h2>
</div>
<div class="info-box-body">
<a name="var$_php_errors" id="$_php_errors"><!-- --></A>
<div class="oddrow">
<div class="evenrow">

<div class="var-header">
<span class="var-title">
Expand Down Expand Up @@ -161,7 +161,7 @@ <h2 class="class-name">Class Environment</h2>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodauto_load" id="auto_load"><!-- --></a>
<div class="evenrow">
<div class="oddrow">

<div class="method-header">
<span class="method-title">static method auto_load</span> (line <span class="line-number">47</span>)
Expand Down Expand Up @@ -192,7 +192,7 @@ <h2 class="class-name">Class Environment</h2>

</div>
<a name="methoderror_handler" id="error_handler"><!-- --></a>
<div class="oddrow">
<div class="evenrow">

<div class="method-header">
<span class="method-title">static method error_handler</span> (line <span class="line-number">75</span>)
Expand Down Expand Up @@ -233,7 +233,7 @@ <h2 class="class-name">Class Environment</h2>

</div>
<a name="methodexception_handler" id="exception_handler"><!-- --></a>
<div class="evenrow">
<div class="oddrow">

<div class="method-header">
<span class="method-title">static method exception_handler</span> (line <span class="line-number">92</span>)
Expand Down Expand Up @@ -263,10 +263,10 @@ <h2 class="class-name">Class Environment</h2>

</div>
<a name="methodexception_text" id="exception_text"><!-- --></a>
<div class="oddrow">
<div class="evenrow">

<div class="method-header">
<span class="method-title">static method exception_text</span> (line <span class="line-number">169</span>)
<span class="method-title">static method exception_text</span> (line <span class="line-number">176</span>)
</div>

<!-- ========== Info from phpDoc block ========= -->
Expand Down Expand Up @@ -294,10 +294,10 @@ <h2 class="class-name">Class Environment</h2>

</div>
<a name="methodset_view" id="set_view"><!-- --></a>
<div class="evenrow">
<div class="oddrow">

<div class="method-header">
<span class="method-title">static method set_view</span> (line <span class="line-number">149</span>)
<span class="method-title">static method set_view</span> (line <span class="line-number">156</span>)
</div>

<!-- ========== Info from phpDoc block ========= -->
Expand Down Expand Up @@ -325,10 +325,10 @@ <h2 class="class-name">Class Environment</h2>

</div>
<a name="methodshutdown_handler" id="shutdown_handler"><!-- --></a>
<div class="oddrow">
<div class="evenrow">

<div class="method-header">
<span class="method-title">static method shutdown_handler</span> (line <span class="line-number">181</span>)
<span class="method-title">static method shutdown_handler</span> (line <span class="line-number">188</span>)
</div>

<!-- ========== Info from phpDoc block ========= -->
Expand Down Expand Up @@ -357,7 +357,7 @@ <h2 class="class-name">Class Environment</h2>


<p class="notes" id="credit">
Documentation generated on Wed, 07 Jul 2010 00:14:54 +1000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 18 Jul 2010 11:44:54 +1000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>
2 changes: 1 addition & 1 deletion docs/Environment/_Environment.php.html
View file
Expand Up @@ -54,7 +54,7 @@ <h2 class="file-name">/Environment.php</h2>


<p class="notes" id="credit">
Documentation generated on Wed, 07 Jul 2010 00:14:54 +1000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 18 Jul 2010 11:44:54 +1000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>
75 changes: 49 additions & 26 deletions docs/Scaffold/Response/Scaffold_Response_Cache.html
View file
Expand Up @@ -30,7 +30,7 @@ <h2 class="class-name">Class Scaffold_Response_Cache</h2>
<li><span class="field">license:</span> <a href="http://opensource.org/licenses/bsd-license.php">New BSD License</a></li>
</ul>
<p class="notes">
Located in <a class="field" href="_Scaffold---Response---Cache.php.html">/Scaffold/Response/Cache.php</a> (line <span class="field">20</span>)
Located in <a class="field" href="_Scaffold---Response---Cache.php.html">/Scaffold/Response/Cache.php</a> (line <span class="field">18</span>)
</p>


Expand All @@ -51,9 +51,9 @@ <h2 class="class-name">Class Scaffold_Response_Cache</h2>
</div>
<div class="info-box-body">
<div class="method-summary">

<div class="method-definition">
<span class="method-result">return</span>
<span class="method-result">void</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
(<span class="var-type">$param</span>&nbsp;<span class="var-name">0</span>)
</div>
Expand All @@ -65,12 +65,17 @@ <h2 class="class-name">Class Scaffold_Response_Cache</h2>
<div class="method-definition">
<span class="method-result">int</span>
<a href="#get_modified_since" title="details" class="method-name">get_modified_since</a>
(<span class="var-type">$param</span>&nbsp;<span class="var-name">0</span>)
()
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#matched" title="details" class="method-name">matched</a>
(<span class="var-type">$etag</span>&nbsp;<span class="var-name">$etag</span>)
</div>
<div class="method-definition">
<span class="method-result">boolean</span>
<a href="#valid" title="details" class="method-name">valid</a>
(<span class="var-type">$last_modified</span>&nbsp;<span class="var-name">$last_modified</span>, <span class="var-type">$etag</span>&nbsp;<span class="var-name">$etag</span>)
<a href="#modified" title="details" class="method-name">modified</a>
(<span class="var-type">$last_modified</span>&nbsp;<span class="var-name">$last_modified</span>)
</div>
</div>
</div>
Expand All @@ -92,19 +97,16 @@ <h2 class="class-name">Class Scaffold_Response_Cache</h2>
<div class="evenrow">

<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">43</span>)
<span class="method-title">Constructor __construct</span> (line <span class="line-number">37</span>)
</div>

<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor</p>
<ul class="tags">
<li><span class="field">return:</span> type</li>
<li><span class="field">author:</span> your name</li>
<li><span class="field">access:</span> public</li>
</ul>

<div class="method-signature">
<span class="method-result">return</span>
<span class="method-result">void</span>
<span class="method-name">
__construct
</span>
Expand All @@ -123,7 +125,7 @@ <h2 class="class-name">Class Scaffold_Response_Cache</h2>
<div class="oddrow">

<div class="method-header">
<span class="method-title">get_etag</span> (line <span class="line-number">76</span>)
<span class="method-title">get_etag</span> (line <span class="line-number">55</span>)
</div>

<!-- ========== Info from phpDoc block ========= -->
Expand All @@ -147,7 +149,7 @@ <h2 class="class-name">Class Scaffold_Response_Cache</h2>
<div class="evenrow">

<div class="method-header">
<span class="method-title">get_modified_since</span> (line <span class="line-number">88</span>)
<span class="method-title">get_modified_since</span> (line <span class="line-number">65</span>)
</div>

<!-- ========== Info from phpDoc block ========= -->
Expand All @@ -161,45 +163,66 @@ <h2 class="class-name">Class Scaffold_Response_Cache</h2>
<span class="method-name">
get_modified_since
</span>
(<span class="var-type">$param</span>&nbsp;<span class="var-name">0</span>)
()
</div>



</div>
<a name="methodmatched" id="matched"><!-- --></a>
<div class="oddrow">

<div class="method-header">
<span class="method-title">matched</span> (line <span class="line-number">118</span>)
</div>

<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">ETags match</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>

<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
matched
</span>
(<span class="var-type">$etag</span>&nbsp;<span class="var-name">$etag</span>)
</div>

<ul class="parameters">
<li>
<span class="var-type">$param</span>
<span class="var-name">0</span> </li>
<span class="var-type">$etag</span>
<span class="var-name">$etag</span> </li>
</ul>


</div>
<a name="methodvalid" id="valid"><!-- --></a>
<div class="oddrow">
<a name="methodmodified" id="modified"><!-- --></a>
<div class="evenrow">

<div class="method-header">
<span class="method-title">valid</span> (line <span class="line-number">65</span>)
<span class="method-title">modified</span> (line <span class="line-number">129</span>)
</div>

<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Checks if the users cache is still valid by checking the last modified time and etag against the browsers sent header.</p>
<p class="short-description">Has the resource been modified?</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>

<div class="method-signature">
<span class="method-result">boolean</span>
<span class="method-name">
valid
modified
</span>
(<span class="var-type">$last_modified</span>&nbsp;<span class="var-name">$last_modified</span>, <span class="var-type">$etag</span>&nbsp;<span class="var-name">$etag</span>)
(<span class="var-type">$last_modified</span>&nbsp;<span class="var-name">$last_modified</span>)
</div>

<ul class="parameters">
<li>
<span class="var-type">$last_modified</span>
<span class="var-name">$last_modified</span> </li>
<li>
<span class="var-type">$etag</span>
<span class="var-name">$etag</span> </li>
</ul>


Expand All @@ -210,7 +233,7 @@ <h2 class="class-name">Class Scaffold_Response_Cache</h2>


<p class="notes" id="credit">
Documentation generated on Wed, 07 Jul 2010 00:14:54 +1000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
Documentation generated on Sun, 18 Jul 2010 11:44:54 +1000 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>

0 comments on commit c07a49e

Please sign in to comment.