doc generation problem

doc/README.md

@@ -0,0 +1,16 @@
+
+
+<h1>The setup application</h1>
+
+The setup application
+=====================
+
+
+<h2 class="indextitle">Modules</h2>
+
+
+
+<table width="100%" border="0" summary="list of modules">
+<tr><td><a href="setup.md" class="module">setup</a></td></tr>
+<tr><td><a href="setup_gen.md" class="module">setup_gen</a></td></tr></table>
+

doc/edoc-info

@@ -0,0 +1,3 @@
+{application,setup}.
+{packages,[]}.
+{modules,[setup,setup_gen]}.

doc/setup.md

@@ -0,0 +1,120 @@
+Module setup
+============
+
+
+<h1>Module setup</h1>
+
+* [Description](#description)
+* [Function Index](#index)
+* [Function Details](#functions)
+
+
+Setup utility for erlang applications.
+
+
+
+__Behaviours:__ [`application`](application.md).
+
+<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="#log_dir-0">log_dir/0</a></td><td>Returns the configured log directory, or a best guess ($CWD/log.Node).</td></tr><tr><td valign="top"><a href="#q-0">q/0</a></td><td>Terminates all nodes gracefully.</td></tr><tr><td valign="top"><a href="#start-2">start/2</a></td><td>Application start function.</td></tr><tr><td valign="top"><a href="#stop-1">stop/1</a></td><td>Application stop function
+end.</td></tr><tr><td valign="top"><a href="#verify_dir-1">verify_dir/1</a></td><td>Ensures that the directory Dir exists and is writable.</td></tr><tr><td valign="top"><a href="#verify_directories-0">verify_directories/0</a></td><td>Ensures that essential directories exist and are writable.</td></tr></table>
+
+
+<a name="functions"></a>
+
+
+<h2>Function Details</h2>
+
+
+<a name="log_dir-0"></a>
+
+
+<h3>log_dir/0</h3>
+
+
+
+
+
+<tt>log_dir() -> Directory</tt>
+
+
+
+Returns the configured log directory, or a best guess ($CWD/log.Node).
+<a name="q-0"></a>
+
+
+<h3>q/0</h3>
+
+
+
+
+
+<tt>q() -> ok</tt>
+
+
+
+Terminates all nodes gracefully.
+<a name="start-2"></a>
+
+
+<h3>start/2</h3>
+
+
+
+
+
+<tt>start(X1::Type, Args) -> {ok, pid()}</tt>
+
+
+
+Application start function.
+<a name="stop-1"></a>
+
+
+<h3>stop/1</h3>
+
+
+
+
+
+<tt>stop(X1::State) -> ok</tt>
+
+
+
+Application stop function
+end
+
+<a name="verify_dir-1"></a>
+
+
+<h3>verify_dir/1</h3>
+
+
+
+
+
+<tt>verify_dir(Directory::Dir) -> Dir</tt>
+
+
+
+Ensures that the directory Dir exists and is writable.
+<a name="verify_directories-0"></a>
+
+
+<h3>verify_directories/0</h3>
+
+
+
+
+
+<tt>verify_directories() -> ok</tt>
+
+
+
+Ensures that essential directories exist and are writable.
+Currently, only the log directory is verified.
+
+_Generated by EDoc, Dec 31 2010, 10:15:21._

doc/setup_gen.md

@@ -0,0 +1,76 @@
+Module setup_gen
+================
+
+
+<h1>Module setup_gen</h1>
+
+* [Function Index](#index)
+* [Function Details](#functions)
+
+
+
+
+
+
+<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="#main-1">main/1</a></td><td></td></tr><tr><td valign="top"><a href="#run-1">run/1</a></td><td>Generates .rel file(s) and boot scripts for a given configuration.</td></tr></table>
+
+
+<a name="functions"></a>
+
+
+<h2>Function Details</h2>
+
+
+<a name="main-1"></a>
+
+
+<h3>main/1</h3>
+
+
+
+
+
+`main(InArgs) -> any()`
+
+
+<a name="run-1"></a>
+
+
+<h3>run/1</h3>
+
+
+
+
+
+<tt>run(Options) -> ok</tt>
+
+
+
+
+
+Generates .rel file(s) and boot scripts for a given configuration.
+
+
+
+This function reads a configuration specification and generates the
+files needed to start a node from an OTP boot script. Optionally, it can
+also generate a 'setup' script, which contains the same applications, but
+only loaded (except the `setup` application, if present, which is started).  
+This way, a node can be started with all paths set, and all environment  
+variables defined, such that a database can be created, and other setup tasks  
+be performed.
+
+
+
+Mandatory options:
+* `{name, Name}`  - Name of the release (and of the .rel and .script files)
+* `{outdir, Dir}` - Where to put the generated files. Dir is created if not                      
+already present.
+
+Additional options:
+
+_Generated by EDoc, Dec 31 2010, 10:15:21._

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
+}

src/setup.erl

@@ -44,7 +44,7 @@ stop(_) ->
     ok.
 
 %% @spec log_dir() -> Directory
-%% @doc Returns the configured log directory, or a best guess ($CWD/log.<node>)
+%% @doc Returns the configured log directory, or a best guess ($CWD/log.Node).
 %% @end
 %%
 log_dir() ->