Permalink
Browse files

Add generated edocs

  • Loading branch information...
1 parent 23d3724 commit 7e3a577484729b3ceb63b497a6696caf50381a30 @lafka committed Sep 6, 2012
View
@@ -0,0 +1,17 @@
+
+
+#The tavern application#
+
+
+##Modules##
+
+
+<table width="100%" border="0" summary="list of modules">
+<tr><td><a href="tavern_http.md" class="module">tavern_http</a></td></tr>
+<tr><td><a href="tavern_marshal.md" class="module">tavern_marshal</a></td></tr>
+<tr><td><a href="tavern_marshal.md.md" class="module">tavern_marshal_html</a></td></tr>
+<tr><td><a href="tavern_marshal_json.md" class="module">tavern_marshal_json</a></td></tr>
+<tr><td><a href="tavern_marshal_plain.md" class="module">tavern_marshal_plain</a></td></tr>
+<tr><td><a href="tavern_marshal_xml.md" class="module">tavern_marshal_xml</a></td></tr>
+<tr><td><a href="tavern_req.md" class="module">tavern_req</a></td></tr></table>
+
View
@@ -0,0 +1,4 @@
+{application,tavern}.
+{packages,[]}.
+{modules,[tavern_http,tavern_marshal,tavern_marshal_html,tavern_marshal_json,
+ tavern_marshal_plain,tavern_marshal_xml,tavern_req]}.
View
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
@@ -0,0 +1,55 @@
+/* standard EDoc style sheet */
+body {
+ font-family: Verdana, Arial, Helvetica, sans-serif;
+ margin-left: .25in;
+ margin-right: .2in;
+ margin-top: 0.2in;
+ margin-bottom: 0.2in;
+ color: #000000;
+ background-color: #ffffff;
+}
+h1,h2 {
+ margin-left: -0.2in;
+}
+div.navbar {
+ background-color: #add8e6;
+ padding: 0.2em;
+}
+h2.indextitle {
+ padding: 0.4em;
+ background-color: #add8e6;
+}
+h3.function,h3.typedecl {
+ background-color: #add8e6;
+ padding-left: 1em;
+}
+div.spec {
+ margin-left: 2em;
+ background-color: #eeeeee;
+}
+a.module,a.package {
+ text-decoration:none
+}
+a.module:hover,a.package:hover {
+ background-color: #eeeeee;
+}
+ul.definitions {
+ list-style-type: none;
+}
+ul.index {
+ list-style-type: none;
+ background-color: #eeeeee;
+}
+
+/*
+ * Minor style tweaks
+ */
+ul {
+ list-style-type: square;
+}
+table {
+ border-collapse: collapse;
+}
+td {
+ padding: 3
+}
View
@@ -0,0 +1,133 @@
+
+
+#Module tavern_http#
+* [Data Types](#types)
+* [Function Index](#index)
+* [Function Details](#functions)
+
+
+
+<a name="types"></a>
+
+##Data Types##
+
+
+
+
+###<a name="type-http_int_status">http_int_status()</a>##
+
+
+
+<pre>http_int_status() = 100..599</pre>
+
+
+
+###<a name="type-key">key()</a>##
+
+
+
+<pre>key() = atom()</pre>
+
+
+
+###<a name="type-mime">mime()</a>##
+
+
+
+<pre>mime() = {binary(), binary()}</pre>
+
+
+
+###<a name="type-mime_charset">mime_charset()</a>##
+
+
+
+<pre>mime_charset() = {binary(), binary(), binary()}</pre>
+
+
+
+###<a name="type-mime_options">mime_options()</a>##
+
+
+
+<pre>mime_options() = {binary(), binary(), [{binary(), binary()}]}</pre>
+
+
+
+###<a name="type-request_method">request_method()</a>##
+
+
+
+<pre>request_method() = atom()</pre>
+
+
+
+###<a name="type-returnstatus">returnstatus()</a>##
+
+
+
+<pre>returnstatus() = <a href="#type-http_int_status">http_int_status()</a> | atom()</pre>
+
+
+
+###<a name="type-tree">tree()</a>##
+
+
+
+<pre>tree() = [{<a href="#type-key">key()</a>, <a href="#type-value">value()</a>}]</pre>
+
+
+
+###<a name="type-value">value()</a>##
+
+
+
+<pre>value() = binary() | number() | string() | <a href="#type-tree">tree()</a></pre>
+<a name="index"></a>
+
+##Function Index##
+
+
+<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#handle-3">handle/3</a></td><td></td></tr><tr><td valign="top"><a href="#init-3">init/3</a></td><td></td></tr><tr><td valign="top"><a href="#status-1">status/1</a></td><td></td></tr><tr><td valign="top"><a href="#terminate-3">terminate/3</a></td><td></td></tr></table>
+
+
+<a name="functions"></a>
+
+##Function Details##
+
+<a name="handle-3"></a>
+
+###handle/3##
+
+
+<pre>handle(Handler::module(), Http_req::#http_req{}, Tavern::#tavern{}) -&gt; {ok, #http_req{}, #tavern{}}</pre>
+<br></br>
+
+
+<a name="init-3"></a>
+
+###init/3##
+
+
+<pre>init(Transport::module(), Req::#http_req{}, X3::[module()]) -&gt; {ok, #http_req{}, #tavern{}}</pre>
+<br></br>
+
+
+<a name="status-1"></a>
+
+###status/1##
+
+
+<pre>status(X1::atom()) -> <a href="#type-http_int_status">http_int_status()</a></pre>
+<br></br>
+
+
+<a name="terminate-3"></a>
+
+###terminate/3##
+
+
+<pre>terminate(Handler::module(), Http_req::#http_req{}, Tavern::#tavern{}) -&gt; ok</pre>
+<br></br>
+
+
View
@@ -0,0 +1,37 @@
+
+
+#Module tavern_marshal#
+* [Function Index](#index)
+* [Function Details](#functions)
+
+
+<a name="index"></a>
+
+##Function Index##
+
+
+<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#decode-2">decode/2</a></td><td></td></tr><tr><td valign="top"><a href="#encode-2">encode/2</a></td><td></td></tr></table>
+
+
+<a name="functions"></a>
+
+##Function Details##
+
+<a name="decode-2"></a>
+
+###decode/2##
+
+
+<pre>decode(Mime::<a href="tavern_http.md#type-mime">tavern_http:mime()</a> | binary(), Encoded::iolist() | binary()) -> Payload::{ok, <a href="tavern_http.md#type-tree">tavern_http:tree()</a>}</pre>
+<br></br>
+
+
+<a name="encode-2"></a>
+
+###encode/2##
+
+
+<pre>encode(Mime::<a href="tavern_http.md#type-mime">tavern_http:mime()</a> | binary(), Payload::<a href="tavern_http.md#type-tree">tavern_http:tree()</a>) -> {ok, Encoded::iolist()}</pre>
+<br></br>
+
+
@@ -0,0 +1,37 @@
+
+
+#Module tavern_marshal_html#
+* [Function Index](#index)
+* [Function Details](#functions)
+
+
+<a name="index"></a>
+
+##Function Index##
+
+
+<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#decode-1">decode/1</a></td><td></td></tr><tr><td valign="top"><a href="#encode-1">encode/1</a></td><td></td></tr></table>
+
+
+<a name="functions"></a>
+
+##Function Details##
+
+<a name="decode-1"></a>
+
+###decode/1##
+
+
+<pre>decode(Payload::binary()) -&gt; {error, not_implemented}</pre>
+<br></br>
+
+
+<a name="encode-1"></a>
+
+###encode/1##
+
+
+<pre>encode(Payload::<a href="tavern_http.md#type-tree">tavern_http:tree()</a>) -> {error, not_implemented}</pre>
+<br></br>
+
+
@@ -0,0 +1,37 @@
+
+
+#Module tavern_marshal_json#
+* [Function Index](#index)
+* [Function Details](#functions)
+
+
+<a name="index"></a>
+
+##Function Index##
+
+
+<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#decode-1">decode/1</a></td><td></td></tr><tr><td valign="top"><a href="#encode-1">encode/1</a></td><td></td></tr></table>
+
+
+<a name="functions"></a>
+
+##Function Details##
+
+<a name="decode-1"></a>
+
+###decode/1##
+
+
+<pre>decode(Payload::binary()) -> {ok, Data::<a href="tavern_http.md#type-tree">tavern_http:tree()</a>} | {error, Error::atom()}</pre>
+<br></br>
+
+
+<a name="encode-1"></a>
+
+###encode/1##
+
+
+<pre>encode(Payload::<a href="tavern_http.md#type-tree">tavern_http:tree()</a>) -> {ok, Data::iolist()} | {error, Error::atom()}</pre>
+<br></br>
+
+
@@ -0,0 +1,37 @@
+
+
+#Module tavern_marshal_plain#
+* [Function Index](#index)
+* [Function Details](#functions)
+
+
+<a name="index"></a>
+
+##Function Index##
+
+
+<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#decode-1">decode/1</a></td><td></td></tr><tr><td valign="top"><a href="#encode-1">encode/1</a></td><td></td></tr></table>
+
+
+<a name="functions"></a>
+
+##Function Details##
+
+<a name="decode-1"></a>
+
+###decode/1##
+
+
+<pre>decode(Payload::binary()) -> {ok, Data::<a href="tavern_http.md#type-tree">tavern_http:tree()</a>}</pre>
+<br></br>
+
+
+<a name="encode-1"></a>
+
+###encode/1##
+
+
+<pre>encode(Payload::<a href="tavern_http.md#type-tree">tavern_http:tree()</a>) -> {ok, Data::iolist()}</pre>
+<br></br>
+
+
Oops, something went wrong.

0 comments on commit 7e3a577

Please sign in to comment.