Updated docs to 0.6.0-RC3

weavejester · Feb 2, 2011 · ebcfb7e · ebcfb7e
1 parent b04d41e
commit ebcfb7e
Show file tree

Hide file tree

Showing 6 changed files with 47 additions and 21 deletions.
diff --git a/api-index.html b/api-index.html
@@ -74,7 +74,7 @@ <h1><a title="page header title" id="page-header" href="index.html">Compojure</a
   <h2 id="A"><span id="section-head">A</span></h2>
   <pre>
 <span id="section-content"> <a href="compojure.core-api.html#compojure.core/ANY">ANY</a><span id="line-content">                          macro         compojure.core     Generate a route that matches any method..
-</span></span><span id="section-content"> <a href="compojure.handler-api.html#compojure.handler/api">api</a><span id="line-content">                          function      compojure.handler  Create a handler suitable for a web API..
+</span></span><span id="section-content"> <a href="compojure.handler-api.html#compojure.handler/api">api</a><span id="line-content">                          function      compojure.handler  Create a handler suitable for a web API. This adds...
 </span></span></pre>
 </div><div id="index-body">
   <h2 id="B"><span id="section-head">B</span></h2>
@@ -152,14 +152,15 @@ <h2 id="Q"><span id="section-head">Q</span></h2>
   <h2 id="R"><span id="section-head">R</span></h2>
   <pre>
 <span id="section-content"> <a href="compojure.response-api.html#compojure.response/render">render</a><span id="line-content">                       function      compojure.response Render the object into a form suitable for the giv...
+</span></span><span id="section-content"> <a href="compojure.response-api.html#compojure.response/resource">resource</a><span id="line-content">                     function      compojure.response Create a resource response..
 </span></span><span id="section-content"> <a href="compojure.route-api.html#compojure.route/resources">resources</a><span id="line-content">                    function      compojure.route    A route for serving resources on the classpath. Ac...
 </span></span><span id="section-content"> <a href="compojure.core-api.html#compojure.core/routes">routes</a><span id="line-content">                       function      compojure.core     Create a Ring handler by combining several handler...
 </span></span><span id="section-content"> <a href="compojure.core-api.html#compojure.core/routing">routing</a><span id="line-content">                      function      compojure.core     Apply a list of routes to a Ring request map..
 </span></span></pre>
 </div><div id="index-body">
   <h2 id="S"><span id="section-head">S</span></h2>
   <pre>
-<span id="section-content"> <a href="compojure.handler-api.html#compojure.handler/site">site</a><span id="line-content">                         function      compojure.handler  Create a handler suitable for a standard website..
+<span id="section-content"> <a href="compojure.handler-api.html#compojure.handler/site">site</a><span id="line-content">                         function      compojure.handler  Create a handler suitable for a standard website. ...
 </span></span></pre>
 </div><div id="index-body">
   <h2 id="T"><span id="section-head">T</span></h2>

diff --git a/compojure.core-api.html b/compojure.core-api.html
@@ -91,7 +91,7 @@ <h2 id="compojure.core/ANY">ANY</h2>
   <pre id="var-usage">Usage: (ANY path args &amp; body)
 </pre>
   <pre id="var-docstr">Generate a route that matches any method.</pre>
-  <a href="http://github.com/weavejester/compojure/blobce52e255d6798b349a857a18907ec4e93134e8ef/src/compojure/core.clj#L113" id="var-source">Source</a>
+  <a href="http://github.com/weavejester/compojure/blobc6378efc74c38116be3ed81f73dfe5fa90f817ac/src/compojure/core.clj#L113" id="var-source">Source</a>
 </div><div id="var-entry">
   <br />
   <hr />
@@ -100,7 +100,7 @@ <h2 id="compojure.core/DELETE">DELETE</h2>
   <pre id="var-usage">Usage: (DELETE path args &amp; body)
 </pre>
   <pre id="var-docstr">Generate a DELETE route.</pre>
-  <a href="http://github.com/weavejester/compojure/blobce52e255d6798b349a857a18907ec4e93134e8ef/src/compojure/core.clj#L105" id="var-source">Source</a>
+  <a href="http://github.com/weavejester/compojure/blobc6378efc74c38116be3ed81f73dfe5fa90f817ac/src/compojure/core.clj#L105" id="var-source">Source</a>
 </div><div id="var-entry">
   <br />
   <hr />
@@ -109,7 +109,7 @@ <h2 id="compojure.core/GET">GET</h2>
   <pre id="var-usage">Usage: (GET path args &amp; body)
 </pre>
   <pre id="var-docstr">Generate a GET route.</pre>
-  <a href="http://github.com/weavejester/compojure/blobce52e255d6798b349a857a18907ec4e93134e8ef/src/compojure/core.clj#L93" id="var-source">Source</a>
+  <a href="http://github.com/weavejester/compojure/blobc6378efc74c38116be3ed81f73dfe5fa90f817ac/src/compojure/core.clj#L93" id="var-source">Source</a>
 </div><div id="var-entry">
   <br />
   <hr />
@@ -118,7 +118,7 @@ <h2 id="compojure.core/HEAD">HEAD</h2>
   <pre id="var-usage">Usage: (HEAD path args &amp; body)
 </pre>
   <pre id="var-docstr">Generate a HEAD route.</pre>
-  <a href="http://github.com/weavejester/compojure/blobce52e255d6798b349a857a18907ec4e93134e8ef/src/compojure/core.clj#L109" id="var-source">Source</a>
+  <a href="http://github.com/weavejester/compojure/blobc6378efc74c38116be3ed81f73dfe5fa90f817ac/src/compojure/core.clj#L109" id="var-source">Source</a>
 </div><div id="var-entry">
   <br />
   <hr />
@@ -127,7 +127,7 @@ <h2 id="compojure.core/POST">POST</h2>
   <pre id="var-usage">Usage: (POST path args &amp; body)
 </pre>
   <pre id="var-docstr">Generate a POST route.</pre>
-  <a href="http://github.com/weavejester/compojure/blobce52e255d6798b349a857a18907ec4e93134e8ef/src/compojure/core.clj#L97" id="var-source">Source</a>
+  <a href="http://github.com/weavejester/compojure/blobc6378efc74c38116be3ed81f73dfe5fa90f817ac/src/compojure/core.clj#L97" id="var-source">Source</a>
 </div><div id="var-entry">
   <br />
   <hr />
@@ -136,7 +136,7 @@ <h2 id="compojure.core/PUT">PUT</h2>
   <pre id="var-usage">Usage: (PUT path args &amp; body)
 </pre>
   <pre id="var-docstr">Generate a PUT route.</pre>
-  <a href="http://github.com/weavejester/compojure/blobce52e255d6798b349a857a18907ec4e93134e8ef/src/compojure/core.clj#L101" id="var-source">Source</a>
+  <a href="http://github.com/weavejester/compojure/blobc6378efc74c38116be3ed81f73dfe5fa90f817ac/src/compojure/core.clj#L101" id="var-source">Source</a>
 </div><div id="var-entry">
   <br />
   <hr />
@@ -146,7 +146,7 @@ <h2 id="compojure.core/defroutes">defroutes</h2>
 </pre>
   <pre id="var-docstr">Define a Ring handler function from a sequence of routes. The name may be
 optionally be followed by a doc-string and metadata map.</pre>
-  <a href="http://github.com/weavejester/compojure/blobce52e255d6798b349a857a18907ec4e93134e8ef/src/compojure/core.clj#L86" id="var-source">Source</a>
+  <a href="http://github.com/weavejester/compojure/blobc6378efc74c38116be3ed81f73dfe5fa90f817ac/src/compojure/core.clj#L86" id="var-source">Source</a>
 </div><div id="var-entry">
   <br />
   <hr />
@@ -155,7 +155,7 @@ <h2 id="compojure.core/routes">routes</h2>
   <pre id="var-usage">Usage: (routes &amp; handlers)
 </pre>
   <pre id="var-docstr">Create a Ring handler by combining several handlers into one.</pre>
-  <a href="http://github.com/weavejester/compojure/blobce52e255d6798b349a857a18907ec4e93134e8ef/src/compojure/core.clj#L81" id="var-source">Source</a>
+  <a href="http://github.com/weavejester/compojure/blobc6378efc74c38116be3ed81f73dfe5fa90f817ac/src/compojure/core.clj#L81" id="var-source">Source</a>
 </div><div id="var-entry">
   <br />
   <hr />
@@ -164,7 +164,7 @@ <h2 id="compojure.core/routing">routing</h2>
   <pre id="var-usage">Usage: (routing request &amp; handlers)
 </pre>
   <pre id="var-docstr">Apply a list of routes to a Ring request map.</pre>
-  <a href="http://github.com/weavejester/compojure/blobce52e255d6798b349a857a18907ec4e93134e8ef/src/compojure/core.clj#L76" id="var-source">Source</a>
+  <a href="http://github.com/weavejester/compojure/blobc6378efc74c38116be3ed81f73dfe5fa90f817ac/src/compojure/core.clj#L76" id="var-source">Source</a>
 </div><div id="var-entry">
   <br />
   <hr />
@@ -179,7 +179,7 @@ <h2 id="compojure.core/wrap!">wrap!</h2>
   (wrap! foo (:session cookie-store))
   =&gt; (wrap! foo (wrap-session cookie-store))
   =&gt; (def foo (wrap-session foo cookie-store))</pre>
-  <a href="http://github.com/weavejester/compojure/blobce52e255d6798b349a857a18907ec4e93134e8ef/src/compojure/core.clj#L165" id="var-source">Source</a>
+  <a href="http://github.com/weavejester/compojure/blobc6378efc74c38116be3ed81f73dfe5fa90f817ac/src/compojure/core.clj#L165" id="var-source">Source</a>
 </div>
 
 

diff --git a/compojure.handler-api.html b/compojure.handler-api.html
@@ -74,17 +74,31 @@ <h2 id="compojure.handler/api">api</h2>
   <span id="var-type">function</span><br />
   <pre id="var-usage">Usage: (api routes)
 </pre>
-  <pre id="var-docstr">Create a handler suitable for a web API.</pre>
-  <a href="http://github.com/weavejester/compojure/blobfa9ccbec1e508a45f227e836c2377308673050c4/src/compojure/handler.clj#L16" id="var-source">Source</a>
+  <pre id="var-docstr">Create a handler suitable for a web API. This adds the following
+middleware to your routes:
+  - wrap-params
+  - wrap-nested-params
+  - wrap-keyword-params</pre>
+  <a href="http://github.com/weavejester/compojure/blob1fac7c2e4f1c13878bf1168edb39644d62d369d6/src/compojure/handler.clj#L15" id="var-source">Source</a>
 </div><div id="var-entry">
   <br />
   <hr />
   <h2 id="compojure.handler/site">site</h2>
   <span id="var-type">function</span><br />
   <pre id="var-usage">Usage: (site routes &amp; [opts])
 </pre>
-  <pre id="var-docstr">Create a handler suitable for a standard website.</pre>
-  <a href="http://github.com/weavejester/compojure/blobfa9ccbec1e508a45f227e836c2377308673050c4/src/compojure/handler.clj#L24" id="var-source">Source</a>
+  <pre id="var-docstr">Create a handler suitable for a standard website. This adds the
+following middleware to your routes:
+  - wrap-session
+  - wrap-cookies
+  - wrap-multipart-params
+  - wrap-params
+  - wrap-nested-params
+  - wrap-keyword-params
+
+A map of options may also be provided. These keys are provided:
+  :session - a map of session middleware options</pre>
+  <a href="http://github.com/weavejester/compojure/blob1fac7c2e4f1c13878bf1168edb39644d62d369d6/src/compojure/handler.clj#L27" id="var-source">Source</a>
 </div>
 
 

diff --git a/compojure.response-api.html b/compojure.response-api.html
@@ -49,6 +49,8 @@ <h1 class="nopad">Table of Contents</h1>
     <a href="#toc0">Overview</a>
     <div style="margin-left: 1em;" class="toc-entry">
       <a href="#compojure.response/render">render</a>
+    </div><div style="margin-left: 1em;" class="toc-entry">
+      <a href="#compojure.response/resource">resource</a>
     </div>
     <br />
   </div>
@@ -74,6 +76,15 @@ <h2 id="compojure.response/render">render</h2>
 </pre>
   <pre id="var-docstr">Render the object into a form suitable for the given request map.</pre>
 
+</div><div id="var-entry">
+  <br />
+  <hr />
+  <h2 id="compojure.response/resource">resource</h2>
+  <span id="var-type">function</span><br />
+  <pre id="var-usage">Usage: (resource path)
+</pre>
+  <pre id="var-docstr">Create a resource response.</pre>
+  <a href="http://github.com/weavejester/compojure/blob513f41b5a18c706268b95940d8a0a75347fc2114/src/compojure/response.clj#L54" id="var-source">Source</a>
 </div>
 
 

diff --git a/compojure.route-api.html b/compojure.route-api.html
@@ -79,7 +79,7 @@ <h2 id="compojure.route/files">files</h2>
   <pre id="var-docstr">A route for serving static files from a directory. Accepts the following
 keys:
   :root - the root path where the files are stored. Defaults to 'public'.</pre>
-  <a href="http://github.com/weavejester/compojure/blob8c2ee9751a1d462d5bdc8648e1cd10b94c9c03eb/src/compojure/route.clj#L11" id="var-source">Source</a>
+  <a href="http://github.com/weavejester/compojure/blob02b6da8cf12e611c3ee63ddd449515d72e6a5d9c/src/compojure/route.clj#L12" id="var-source">Source</a>
 </div><div id="var-entry">
   <br />
   <hr />
@@ -89,7 +89,7 @@ <h2 id="compojure.route/not-found">not-found</h2>
 </pre>
   <pre id="var-docstr">A route that returns a 404 not found response, with its argument as the
 response body.</pre>
-  <a href="http://github.com/weavejester/compojure/blob8c2ee9751a1d462d5bdc8648e1cd10b94c9c03eb/src/compojure/route.clj#L29" id="var-source">Source</a>
+  <a href="http://github.com/weavejester/compojure/blob02b6da8cf12e611c3ee63ddd449515d72e6a5d9c/src/compojure/route.clj#L30" id="var-source">Source</a>
 </div><div id="var-entry">
   <br />
   <hr />
@@ -99,8 +99,8 @@ <h2 id="compojure.route/resources">resources</h2>
 </pre>
   <pre id="var-docstr">A route for serving resources on the classpath. Accepts the following
 keys:
-  :root - the root prefix to get the resources from. Defaults to '/public'.</pre>
-  <a href="http://github.com/weavejester/compojure/blob8c2ee9751a1d462d5bdc8648e1cd10b94c9c03eb/src/compojure/route.clj#L20" id="var-source">Source</a>
+  :root - the root prefix to get the resources from. Defaults to 'public'.</pre>
+  <a href="http://github.com/weavejester/compojure/blob02b6da8cf12e611c3ee63ddd449515d72e6a5d9c/src/compojure/route.clj#L21" id="var-source">Source</a>
 </div>
 
 

diff --git a/index.html b/index.html
@@ -99,7 +99,7 @@ <h2 id="compojure.response">compojure.response</h2>
   <pre id="namespace-docstr">Methods for generating Ring response maps</pre>
 
   Public variables and functions:
-  <span id="var-link"><a href="compojure.response-api.html#compojure.response/render" id="var-tag">render</a> </span><br />
+  <span id="var-link"><a href="compojure.response-api.html#compojure.response/render" id="var-tag">render</a> </span><span id="var-link"><a href="compojure.response-api.html#compojure.response/resource" id="var-tag">resource</a> </span><br />
 
 </div><div id="namespace-entry">
   <br />