added edocs

ammer · Jan 11, 2009 · c168f4f · c168f4f
1 parent 18fa99a
commit c168f4f
Show file tree

Hide file tree

Showing 10 changed files with 289 additions and 18 deletions.
diff --git a/Makefile b/Makefile
@@ -1,5 +1,12 @@
+APP_NAME="merle"
+VSN="pre0.1"
+
 all: compile
 
+docs: 
+	erl -noshell -run edoc_run application "'$(APP_NAME)'" '"."' '$(VSN)' -s init stop
+
+
 compile:
 	@erl -make
 

diff --git a/doc/edoc-info b/doc/edoc-info
@@ -0,0 +1,3 @@
+{application,merle}.
+{packages,[]}.
+{modules,[merle]}.
diff --git a/doc/erlang.png b/doc/erlang.png
diff --git a/doc/index.html b/doc/index.html
@@ -0,0 +1,17 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<title>The merle application</title>
+</head>
+<frameset cols="20%,80%">
+<frame src="modules-frame.html" name="modulesFrame" title="">
+
+<frame src="overview-summary.html" name="overviewFrame" title="">
+<noframes>
+<h2>This page uses frames</h2>
+<p>Your browser does not accept frames.
+<br>You should go to the <a href="overview-summary.html">non-frame version</a> instead.
+</p>
+</noframes>
+</frameset>
+</html>
diff --git a/doc/merle.html b/doc/merle.html
@@ -0,0 +1,147 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<title>Module merle</title>
+<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
+</head>
+<body bgcolor="white">
+<div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
+<hr>
+
+<h1>Module merle</h1>
+<ul class="index"><li><a href="#description">Description</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>an erlang memcached client.
+<p>Copyright © 2008 Joseph Williams</p>
+
+<p><b>Version:</b> pre 0.1</p>
+<p><b>Behaviours:</b> <a href="gen_server.html"><tt>gen_server</tt></a>.</p>
+<p><b>Authors:</b> Joseph Williams (<a href="mailto:joe@joetify.com"><tt>joe@joetify.com</tt></a>).</p>
+
+<h2><a name="description">Description</a></h2><p>an erlang memcached client.</p>
+
+  <p>This code is available as Open Source Software under the MIT license.</p>
+
+  Updates at http://github.com/joewilliams/merle/
+<h2><a name="index">Function Index</a></h2>
+<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#add-4">add/4</a></td><td>add - "store this value, but only if the server *doesn't* already hold Value for this key".</td></tr>
+<tr><td valign="top"><a href="#append-2">append/2</a></td><td>append - "add this value to an existing key after existing Value".</td></tr>
+<tr><td valign="top"><a href="#cas-5">cas/5</a></td><td>cas - "store this Vvlue but only if no one else has updated since I last fetched it".</td></tr>
+<tr><td valign="top"><a href="#code_change-3">code_change/3</a></td><td></td></tr>
+<tr><td valign="top"><a href="#decrement-2">decrement/2</a></td><td>decrement the value.</td></tr>
+<tr><td valign="top"><a href="#delete-2">delete/2</a></td><td>Delete a key and specify time.</td></tr>
+<tr><td valign="top"><a href="#get-1">get/1</a></td><td>Retrieve value based off of key.</td></tr>
+<tr><td valign="top"><a href="#handle_call-3">handle_call/3</a></td><td></td></tr>
+<tr><td valign="top"><a href="#handle_cast-2">handle_cast/2</a></td><td></td></tr>
+<tr><td valign="top"><a href="#handle_info-2">handle_info/2</a></td><td></td></tr>
+<tr><td valign="top"><a href="#increment-2">increment/2</a></td><td>increment the value.</td></tr>
+<tr><td valign="top"><a href="#init-1">init/1</a></td><td></td></tr>
+<tr><td valign="top"><a href="#prepend-2">prepend/2</a></td><td>prepend - "add this value to an existing key before existing Value".</td></tr>
+<tr><td valign="top"><a href="#quit-0">quit/0</a></td><td>close the socket.</td></tr>
+<tr><td valign="top"><a href="#replace-4">replace/4</a></td><td>replace - "store this value, but only if the server *does* already hold Value for this key".</td></tr>
+<tr><td valign="top"><a href="#set-4">set/4</a></td><td>set - "store this value".</td></tr>
+<tr><td valign="top"><a href="#start_link-2">start_link/2</a></td><td></td></tr>
+<tr><td valign="top"><a href="#stats-0">stats/0</a></td><td>Retrieve memcached stats.</td></tr>
+<tr><td valign="top"><a href="#terminate-2">terminate/2</a></td><td></td></tr>
+</table>
+
+<h2><a name="functions">Function Details</a></h2>
+
+<h3 class="function"><a name="add-4">add/4</a></h3>
+<div class="spec">
+<p><tt>add(Key, Flag, ExpTime, Value) -&gt; any()</tt></p>
+</div><p>add - "store this value, but only if the server *doesn't* already hold Value for this key"</p>
+
+<h3 class="function"><a name="append-2">append/2</a></h3>
+<div class="spec">
+<p><tt>append(Key, Value) -&gt; any()</tt></p>
+</div><p>append - "add this value to an existing key after existing Value"</p>
+
+<h3 class="function"><a name="cas-5">cas/5</a></h3>
+<div class="spec">
+<p><tt>cas(Key, Flag, ExpTime, CasUniq, Value) -&gt; any()</tt></p>
+</div><p>cas - "store this Vvlue but only if no one else has updated since I last fetched it"</p>
+
+<h3 class="function"><a name="code_change-3">code_change/3</a></h3>
+<div class="spec">
+<p><tt>code_change(OldVsn, State, Extra) -&gt; any()</tt></p>
+</div>
+
+<h3 class="function"><a name="decrement-2">decrement/2</a></h3>
+<div class="spec">
+<p><tt>decrement(Key, Value) -&gt; any()</tt></p>
+</div><p>decrement the value</p>
+
+<h3 class="function"><a name="delete-2">delete/2</a></h3>
+<div class="spec">
+<p><tt>delete(Key, Time) -&gt; any()</tt></p>
+</div><p>Delete a key and specify time.</p>
+
+<h3 class="function"><a name="get-1">get/1</a></h3>
+<div class="spec">
+<p><tt>get(Key) -&gt; any()</tt></p>
+</div><p>Retrieve value based off of key</p>
+
+<h3 class="function"><a name="handle_call-3">handle_call/3</a></h3>
+<div class="spec">
+<p><tt>handle_call(X1, From, State) -&gt; any()</tt></p>
+</div>
+
+<h3 class="function"><a name="handle_cast-2">handle_cast/2</a></h3>
+<div class="spec">
+<p><tt>handle_cast(Msg, State) -&gt; any()</tt></p>
+</div>
+
+<h3 class="function"><a name="handle_info-2">handle_info/2</a></h3>
+<div class="spec">
+<p><tt>handle_info(Info, State) -&gt; any()</tt></p>
+</div>
+
+<h3 class="function"><a name="increment-2">increment/2</a></h3>
+<div class="spec">
+<p><tt>increment(Key, Value) -&gt; any()</tt></p>
+</div><p>increment the value</p>
+
+<h3 class="function"><a name="init-1">init/1</a></h3>
+<div class="spec">
+<p><tt>init(X1) -&gt; any()</tt></p>
+</div>
+
+<h3 class="function"><a name="prepend-2">prepend/2</a></h3>
+<div class="spec">
+<p><tt>prepend(Key, Value) -&gt; any()</tt></p>
+</div><p>prepend - "add this value to an existing key before existing Value"</p>
+
+<h3 class="function"><a name="quit-0">quit/0</a></h3>
+<div class="spec">
+<p><tt>quit() -&gt; any()</tt></p>
+</div><p>close the socket</p>
+
+<h3 class="function"><a name="replace-4">replace/4</a></h3>
+<div class="spec">
+<p><tt>replace(Key, Flag, ExpTime, Value) -&gt; any()</tt></p>
+</div><p>replace - "store this value, but only if the server *does* already hold Value for this key"</p>
+
+<h3 class="function"><a name="set-4">set/4</a></h3>
+<div class="spec">
+<p><tt>set(Key, Flag, ExpTime, Value) -&gt; any()</tt></p>
+</div><p>set - "store this value"</p>
+
+<h3 class="function"><a name="start_link-2">start_link/2</a></h3>
+<div class="spec">
+<p><tt>start_link(Host, Port) -&gt; any()</tt></p>
+</div>
+
+<h3 class="function"><a name="stats-0">stats/0</a></h3>
+<div class="spec">
+<p><tt>stats() -&gt; any()</tt></p>
+</div><p>Retrieve memcached stats</p>
+
+<h3 class="function"><a name="terminate-2">terminate/2</a></h3>
+<div class="spec">
+<p><tt>terminate(Reason, State) -&gt; any()</tt></p>
+</div>
+<hr>
+
+<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
+<p><i>Generated by EDoc, Jan 11 2009, 14:39:26.</i></p>
+</body>
+</html>
diff --git a/doc/modules-frame.html b/doc/modules-frame.html
@@ -0,0 +1,12 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<title>The merle application</title>
+<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
+</head>
+<body bgcolor="white">
+<h2 class="indextitle">Modules</h2>
+<table width="100%" border="0" summary="list of modules">
+<tr><td><a href="merle.html" target="overviewFrame" class="module">merle</a></td></tr></table>
+</body>
+</html>
diff --git a/doc/overview-summary.html b/doc/overview-summary.html
@@ -0,0 +1,15 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<title>The merle application</title>
+<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
+</head>
+<body bgcolor="white">
+<div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
+<h1>The merle application</h1>
+
+<hr>
+<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
+<p><i>Generated by EDoc, Jan 11 2009, 14:39:26.</i></p>
+</body>
+</html>
diff --git a/doc/packages-frame.html b/doc/packages-frame.html
@@ -0,0 +1,11 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<title>The merle application</title>
+<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
+</head>
+<body bgcolor="white">
+<h2 class="indextitle">Packages</h2>
+<table width="100%" border="0" summary="list of packages"></table>
+</body>
+</html>
diff --git a/doc/stylesheet.css b/doc/stylesheet.css
@@ -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
+}