edown docs generated

README.md

@@ -1,5 +1,13 @@
 A behaviour/support library for writing plain Erlang FSMs.
 ==========================================================
+
+Note on documentation
+---------------------
+This application now uses edown for github-friendly generation
+of edoc markup. To rebuild documentation, use:
+`./rebar get-deps`
+`./rebar compile`
+`./rebar doc`
 
 This module implements an OTP behaviour for writing plain Erlang FSMs,
 alleviating a long-standing gripe of mine that the OTP behaviours, for all

doc/README.md

@@ -0,0 +1,13 @@
+
+
+#The plain_fsm application#
+The plain_fsm application
+=========================
+
+
+##Modules##
+
+<table width="100%" border="0" summary="list of modules">
+<tr><td><a href="fsm_example.md" class="module">fsm_example</a></td></tr>
+<tr><td><a href="plain_fsm.md" class="module">plain_fsm</a></td></tr>
+<tr><td><a href="plain_fsm_xform.md" class="module">plain_fsm_xform</a></td></tr></table>

doc/edoc-info

@@ -0,0 +1,3 @@
+{application,plain_fsm}.
+{packages,[]}.
+{modules,[fsm_example,plain_fsm,plain_fsm_xform]}.

doc/fsm_example.md

@@ -0,0 +1,60 @@
+Module fsm_example
+==================
+
+
+#Module fsm_example#
+* [Function Index](#index)
+* [Function Details](#functions)
+
+__Behaviours:__ [`plain_fsm`](plain_fsm.html).
+
+##<a name="index">Function Index</a>##
+
+<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#a-1">a/1</a></td><td></td></tr><tr><td valign="top"><a href="#b-1">b/1</a></td><td></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="#data_vsn-0">data_vsn/0</a></td><td></td></tr><tr><td valign="top"><a href="#spawn_link-0">spawn_link/0</a></td><td></td></tr></table>
+
+<a name="functions"></a>
+
+
+##Function Details##
+
+<a name="a-1"></a>
+
+
+###a/1##
+
+
+`a(S) -> any()`
+
+<a name="b-1"></a>
+
+
+###b/1##
+
+
+`b(S) -> any()`
+
+<a name="code_change-3"></a>
+
+
+###code_change/3##
+
+
+`code_change(OldVsn, State, Extra) -> any()`
+
+<a name="data_vsn-0"></a>
+
+
+###data_vsn/0##
+
+
+`data_vsn() -> any()`
+
+<a name="spawn_link-0"></a>
+
+
+###spawn_link/0##
+
+
+`spawn_link() -> any()`
+
+_Generated by EDoc, Oct 23 2010, 21:09:49._