Browse Source

Revert "unignore and add generated edoc documentation"

This reverts commit 65447974ffbffc1e0e49a8091cbfdf73421fbf28.

github doesn't display these docs as I had hoped and having the
generated files in git is going to be a pain since they contain
generated time stamps.
Seth Falcon 14 years ago
parent
commit
8483ea6dc7

+ 4 - 1
.gitignore

@@ -1,4 +1,7 @@
 ebin
 ebin
 *.beam
 *.beam
+doc/*.html
 .eunit
 .eunit
-
+/doc/stylesheet.css
+/doc/erlang.png
+/doc/edoc-info

+ 0 - 4
doc/edoc-info

@@ -1,4 +0,0 @@
-{application,pooler}.
-{packages,[]}.
-{modules,[pooler,pooler_app,pooler_pool_sup,pooler_pooled_worker_sup,
-          pooler_sup]}.

BIN
doc/erlang.png


+ 0 - 17
doc/index.html

@@ -1,17 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<html>
-<head>
-<title>The pooler 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>

+ 0 - 16
doc/modules-frame.html

@@ -1,16 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<html>
-<head>
-<title>The pooler 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="pooler.html" target="overviewFrame" class="module">pooler</a></td></tr>
-<tr><td><a href="pooler_app.html" target="overviewFrame" class="module">pooler_app</a></td></tr>
-<tr><td><a href="pooler_pool_sup.html" target="overviewFrame" class="module">pooler_pool_sup</a></td></tr>
-<tr><td><a href="pooler_pooled_worker_sup.html" target="overviewFrame" class="module">pooler_pooled_worker_sup</a></td></tr>
-<tr><td><a href="pooler_sup.html" target="overviewFrame" class="module">pooler_sup</a></td></tr></table>
-</body>
-</html>

+ 0 - 81
doc/overview-summary.html

@@ -1,81 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<html>
-<head>
-<title>pooler - An OTP Process Pool 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>pooler - An OTP Process Pool Application</h1>
-<p>Copyright © 2011 Seth Falcon</p>
-<p><b>Authors:</b> Seth Falcon (<a href="mailto:seth@userprimary.net"><tt>seth@userprimary.net</tt></a>).</p>
-<p>
-The pooler application allows you to manage pools of OTP behaviors
-such as gen_servers, gen_fsms, or supervisors, and provide consumers
-with exclusive access to pool members using pooler:take_member.</p>
-
-<p>See the README.org file for a good introduction to what pooler is all
-about.</p>
-
-<h3><a name="Pooler_Configuration">Pooler Configuration</a></h3>
-
-<p>Pool configuration is specified in the pooler application's
-environment.  This can be provided in a config file using <code>-config</code> or
-set at startup using <code>application:set_env(pooler, pools, Pools)</code>.
-Here's an example config file that creates three pools of
-Riak pb clients each talking to a different node in a local cluster:</p>
-
-<pre>% pooler.config
-% Start Erlang as: erl -config pooler
-% -*- mode: erlang -*-
-% pooler app config
-[
- {pooler, [
-         {pools, [
-                  [{name, "rc8081"},
-                   {max_count, 5},
-                   {init_count, 2},
-                   {start_mfa,
-                    {riakc_pb_socket, start_link, ["localhost", 8081]}}],
-
-                  [{name, "rc8082"},
-                   {max_count, 5},
-                   {init_count, 2},
-                   {start_mfa,
-                    {riakc_pb_socket, start_link, ["localhost", 8082]}}],
-
-                  [{name, "rc8083"},
-                   {max_count, 5},
-                   {init_count, 2},
-                   {start_mfa,
-                    {riakc_pb_socket, start_link, ["localhost", 8083]}}]
-                 ]}
-        ]}
-].</pre>
-
-<h3><a name="Using_pooler">Using pooler</a></h3>
-
-<p>Here's an example session:</p>
-
-<pre>application:start(pooler).
-P = pooler:take_member(),
-% use P
-pooler:return_member(P, ok).</pre>
-
-<p>Once started, the main interaction you will have with pooler is through
-two functions, <code>take_member/0</code> and <code>return_member/2</code>.</p>
-
-Call <code>pooler:take_member()</code> to obtain a member from a randomly
-selected pool.  When you are done with it, return it to the pool using
-<code>pooler:return_member(Pid, ok)</code>.  If you encountered an error using
-the member, you can pass <code>fail</code> as the second argument.  In this case,
-pooler will permanently remove that member from the pool and start a
-new member to replace it.  If your process is short lived, you can
-omit the call to <code>return_member</code>.  In this case, pooler will detect
-the normal exit of the consumer and reclaim the member.
-
-<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, Apr 17 2011, 16:02:59.</i></p>
-</body>
-</html>

+ 0 - 11
doc/packages-frame.html

@@ -1,11 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<html>
-<head>
-<title>The pooler 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>

+ 0 - 118
doc/pooler.html

@@ -1,118 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<html>
-<head>
-<title>Module pooler</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 pooler</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>This is the main interface to the pooler application.
-<p>Copyright © 2011 Seth Falcon</p>
-
-<p><b>Behaviours:</b> <a href="gen_server.html"><tt>gen_server</tt></a>.</p>
-<p><b>Authors:</b> Seth Falcon (<a href="mailto:seth@userprimary.net"><tt>seth@userprimary.net</tt></a>).</p>
-
-<h2><a name="description">Description</a></h2><p>This is the main interface to the pooler application</p>
- 
-  To integrate with your application, you probably want to call
-  application:start(pooler) after having specified appropriate
-  configuration for the pooler application (either via a config file
-  or appropriate calls to the application module to set the
-  application's config).
- 
-<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="#code_change-3">code_change/3</a></td><td></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="#init-1">init/1</a></td><td></td></tr>
-<tr><td valign="top"><a href="#pool_stats-0">pool_stats/0</a></td><td>Obtain runtime state info for all pools.</td></tr>
-<tr><td valign="top"><a href="#return_member-2">return_member/2</a></td><td>Return a member to the pool so it can be reused.</td></tr>
-<tr><td valign="top"><a href="#start-1">start/1</a></td><td></td></tr>
-<tr><td valign="top"><a href="#start_link-1">start_link/1</a></td><td></td></tr>
-<tr><td valign="top"><a href="#stop-0">stop/0</a></td><td></td></tr>
-<tr><td valign="top"><a href="#take_member-0">take_member/0</a></td><td>Obtain exclusive access to a member from a randomly selected pool.</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="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="handle_call-3">handle_call/3</a></h3>
-<div class="spec">
-<p><tt>handle_call(Request, 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="init-1">init/1</a></h3>
-<div class="spec">
-<p><tt>init(Config) -&gt; any()</tt></p>
-</div>
-
-<h3 class="function"><a name="pool_stats-0">pool_stats/0</a></h3>
-<div class="spec">
-<p><tt>pool_stats() -&gt; any()</tt></p>
-</div><p><p>Obtain runtime state info for all pools.</p>
- 
-  Format of the return value is subject to change.</p>
-
-<h3 class="function"><a name="return_member-2">return_member/2</a></h3>
-<div class="spec">
-<p><tt>return_member(Pid, Status) -&gt; any()</tt></p>
-</div><p><p>Return a member to the pool so it can be reused.</p>
- 
-  If <code>Status</code> is 'ok', the member is returned to the pool.  If
-  <code>Status</code> is 'fail', the member is destroyed and a new member is
-  added to the pool in its place.</p>
-
-<h3 class="function"><a name="start-1">start/1</a></h3>
-<div class="spec">
-<p><tt>start(Config) -&gt; any()</tt></p>
-</div>
-
-<h3 class="function"><a name="start_link-1">start_link/1</a></h3>
-<div class="spec">
-<p><tt>start_link(Config) -&gt; any()</tt></p>
-</div>
-
-<h3 class="function"><a name="stop-0">stop/0</a></h3>
-<div class="spec">
-<p><tt>stop() -&gt; any()</tt></p>
-</div>
-
-<h3 class="function"><a name="take_member-0">take_member/0</a></h3>
-<div class="spec">
-<p><tt>take_member() -&gt; any()</tt></p>
-</div><p><p>Obtain exclusive access to a member from a randomly selected pool.</p>
- 
-  If there are no free members in the randomly selected pool, then a
-  member will be returned from the pool with the most free members.
-  If no free members are available, 'error_no_members' is returned.
- </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, Apr 17 2011, 16:02:59.</i></p>
-</body>
-</html>

+ 0 - 37
doc/pooler_app.html

@@ -1,37 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<html>
-<head>
-<title>Module pooler_app</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 pooler_app</h1>
-<ul class="index"><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>
-
-<p><b>Behaviours:</b> <a href="application.html"><tt>application</tt></a>.</p>
-
-<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="#start-2">start/2</a></td><td></td></tr>
-<tr><td valign="top"><a href="#stop-1">stop/1</a></td><td></td></tr>
-</table>
-
-<h2><a name="functions">Function Details</a></h2>
-
-<h3 class="function"><a name="start-2">start/2</a></h3>
-<div class="spec">
-<p><tt>start(StartType, StartArgs) -&gt; any()</tt></p>
-</div>
-
-<h3 class="function"><a name="stop-1">stop/1</a></h3>
-<div class="spec">
-<p><tt>stop(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, Apr 17 2011, 16:02:59.</i></p>
-</body>
-</html>

+ 0 - 37
doc/pooler_pool_sup.html

@@ -1,37 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<html>
-<head>
-<title>Module pooler_pool_sup</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 pooler_pool_sup</h1>
-<ul class="index"><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>
-
-<p><b>Behaviours:</b> <a href="supervisor.html"><tt>supervisor</tt></a>.</p>
-
-<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="#init-1">init/1</a></td><td></td></tr>
-<tr><td valign="top"><a href="#start_link-0">start_link/0</a></td><td></td></tr>
-</table>
-
-<h2><a name="functions">Function Details</a></h2>
-
-<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="start_link-0">start_link/0</a></h3>
-<div class="spec">
-<p><tt>start_link() -&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, Apr 17 2011, 16:02:59.</i></p>
-</body>
-</html>

+ 0 - 37
doc/pooler_pooled_worker_sup.html

@@ -1,37 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<html>
-<head>
-<title>Module pooler_pooled_worker_sup</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 pooler_pooled_worker_sup</h1>
-<ul class="index"><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>
-
-<p><b>Behaviours:</b> <a href="supervisor.html"><tt>supervisor</tt></a>.</p>
-
-<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="#init-1">init/1</a></td><td></td></tr>
-<tr><td valign="top"><a href="#start_link-1">start_link/1</a></td><td></td></tr>
-</table>
-
-<h2><a name="functions">Function Details</a></h2>
-
-<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="start_link-1">start_link/1</a></h3>
-<div class="spec">
-<p><tt>start_link(Config) -&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, Apr 17 2011, 16:02:59.</i></p>
-</body>
-</html>

+ 0 - 37
doc/pooler_sup.html

@@ -1,37 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<html>
-<head>
-<title>Module pooler_sup</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 pooler_sup</h1>
-<ul class="index"><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>
-
-<p><b>Behaviours:</b> <a href="supervisor.html"><tt>supervisor</tt></a>.</p>
-
-<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="#init-1">init/1</a></td><td></td></tr>
-<tr><td valign="top"><a href="#start_link-0">start_link/0</a></td><td></td></tr>
-</table>
-
-<h2><a name="functions">Function Details</a></h2>
-
-<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="start_link-0">start_link/0</a></h3>
-<div class="spec">
-<p><tt>start_link() -&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, Apr 17 2011, 16:02:59.</i></p>
-</body>
-</html>

+ 0 - 55
doc/stylesheet.css

@@ -1,55 +0,0 @@
-/* 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
-}