Skip to content

Commit

Permalink
Update edocs
Browse files Browse the repository at this point in the history
  • Loading branch information
@norton
norton committed Aug 1, 2012
1 parent 3201dc1 commit ffd096a
Show file tree
Hide file tree
Showing 28 changed files with 214 additions and 427 deletions.
4 changes: 3 additions & 1 deletion README.md
View file
Expand Up @@ -350,7 +350,7 @@ Caution
</td>
<td class="content">If you manually run dialyzer with the "-r" option, execute
"make clean compile" first to avoid finding duplicate beam files
underneath rebar's .eunit directory. Check Makefile for further
underneath rebar's .test directory. Check Makefile for further
information.</td>
</tr></table>

Expand Down Expand Up @@ -485,6 +485,8 @@ has also given his blessing to Gemini's license choice.</p>
<tr><td><a href="https://github.com/ubf/ubf/blob/master/doc/ebf_driver.md" class="module">ebf_driver</a></td></tr>
<tr><td><a href="https://github.com/ubf/ubf/blob/master/doc/proc_socket_server.md" class="module">proc_socket_server</a></td></tr>
<tr><td><a href="https://github.com/ubf/ubf/blob/master/doc/proc_utils.md" class="module">proc_utils</a></td></tr>
<tr><td><a href="https://github.com/ubf/ubf/blob/master/doc/qc_ubf.md" class="module">qc_ubf</a></td></tr>
<tr><td><a href="https://github.com/ubf/ubf/blob/master/doc/qc_ubf_types.md" class="module">qc_ubf_types</a></td></tr>
<tr><td><a href="https://github.com/ubf/ubf/blob/master/doc/ubf.md" class="module">ubf</a></td></tr>
<tr><td><a href="https://github.com/ubf/ubf/blob/master/doc/ubf_client.md" class="module">ubf_client</a></td></tr>
<tr><td><a href="https://github.com/ubf/ubf/blob/master/doc/ubf_driver.md" class="module">ubf_driver</a></td></tr>
Expand Down
4 changes: 3 additions & 1 deletion doc/README.md
View file
Expand Up @@ -350,7 +350,7 @@ Caution
</td>
<td class="content">If you manually run dialyzer with the "-r" option, execute
"make clean compile" first to avoid finding duplicate beam files
underneath rebar's .eunit directory. Check Makefile for further
underneath rebar's .test directory. Check Makefile for further
information.</td>
</tr></table>

Expand Down Expand Up @@ -485,6 +485,8 @@ has also given his blessing to Gemini's license choice.</p>
<tr><td><a href="ebf_driver.md" class="module">ebf_driver</a></td></tr>
<tr><td><a href="proc_socket_server.md" class="module">proc_socket_server</a></td></tr>
<tr><td><a href="proc_utils.md" class="module">proc_utils</a></td></tr>
<tr><td><a href="qc_ubf.md" class="module">qc_ubf</a></td></tr>
<tr><td><a href="qc_ubf_types.md" class="module">qc_ubf_types</a></td></tr>
<tr><td><a href="ubf.md" class="module">ubf</a></td></tr>
<tr><td><a href="ubf_client.md" class="module">ubf_client</a></td></tr>
<tr><td><a href="ubf_driver.md" class="module">ubf_driver</a></td></tr>
Expand Down
18 changes: 1 addition & 17 deletions doc/contract_driver.md
View file
Expand Up @@ -8,8 +8,6 @@

<p>Generic protocol driver process for protocol sessions.</p>.



__This module defines the `contract_driver` behaviour.__
<br></br>
Required callback functions: `start/1`, `start/2`, `init/1`, `init/2`, `encode/3`, `decode/5`.<a name="index"></a>
Expand Down Expand Up @@ -57,39 +55,29 @@ If one side dies the process dies
###behaviour_info/1##




`behaviour_info(X1) -> any()`
`behaviour_info(Other) -> any()`

<a name="loop-5"></a>

###loop/5##




`loop(Module, Contract, Options, Pid, Socket) -> any()`

<a name="loop-6"></a>

###loop/6##




`loop(Module, Contract, Options, Pid, Socket, Timeout) -> any()`

<a name="loop-7"></a>

###loop/7##




`loop(Module, Contract, Options, Pid, Socket, Timeout, Cont) -> any()`



<p>Driver main loop.</p>
<ul>
<li>
Expand Down Expand Up @@ -124,16 +112,12 @@ If one side dies the process dies
###relay/3##




`relay(Module, Pid, Pid1) -> any()`

<a name="start-3"></a>

###start/3##




`start(Module, Contract, Options) -> any()`

20 changes: 0 additions & 20 deletions doc/contract_lex.md
View file
Expand Up @@ -5,8 +5,6 @@
* [Function Details](#functions)




<a name="index"></a>

##Function Index##
Expand All @@ -24,79 +22,61 @@
###format_error/1##




`format_error(X1) -> any()`

<a name="parse_erlang_single_expr-1"></a>

###parse_erlang_single_expr/1##




`parse_erlang_single_expr(Str0) -> any()`

<a name="reserved_word-1"></a>

###reserved_word/1##




`reserved_word(X1) -> any()`

<a name="string-1"></a>

###string/1##




`string(String) -> any()`

<a name="string-2"></a>

###string/2##




`string(String, Line) -> any()`

<a name="token-2"></a>

###token/2##




`token(Cont, Chars) -> any()`

<a name="token-3"></a>

###token/3##




`token(X1, Chars, Line) -> any()`

<a name="tokens-2"></a>

###tokens/2##




`tokens(Cont, Chars) -> any()`

<a name="tokens-3"></a>

###tokens/3##




`tokens(X1, Chars, Line) -> any()`

22 changes: 0 additions & 22 deletions doc/contract_manager.md
View file
Expand Up @@ -81,89 +81,69 @@ actual server application.</tt></pre>
###do_eventIn/4##




`do_eventIn(Msg, State, Mod, TLogMod) -> any()`

<a name="do_eventOut-4"></a>

###do_eventOut/4##




`do_eventOut(Msg, State, Mod, TLogMod) -> any()`

<a name="do_lpcIn-4"></a>

###do_lpcIn/4##




`do_lpcIn(Q, State, Mod, TLogMod) -> any()`

<a name="do_lpcOut-9"></a>

###do_lpcOut/9##




`do_lpcOut(Ref, Q, State, Mod, Reply, ReplyState, NewState, NewMod, TLogMod) -> any()`

<a name="do_lpcOutError-6"></a>

###do_lpcOutError/6##




`do_lpcOutError(Ref, Q, State, Mod, Error, TLogMod) -> any()`

<a name="do_rpcIn-4"></a>

###do_rpcIn/4##




`do_rpcIn(Q, State, Mod, TLogMod) -> any()`

<a name="do_rpcOut-9"></a>

###do_rpcOut/9##




`do_rpcOut(Ref, Q, State, Mod, Reply, ReplyState, NewState, NewMod, TLogMod) -> any()`

<a name="do_rpcOutError-5"></a>

###do_rpcOutError/5##




`do_rpcOutError(Q, State, Mod, Error, TLogMod) -> any()`

<a name="do_rpcOutError-6"></a>

###do_rpcOutError/6##




`do_rpcOutError(Ref, Q, State, Mod, Error, TLogMod) -> any()`

<a name="start-1"></a>

###start/1##




<pre>start(SpawnOpts::list()) -&gt; pid()</pre>
<br></br>

Expand All @@ -173,8 +153,6 @@ actual server application.</tt></pre>
###start/3##




<pre>start(SimpleRPC::boolean(), VerboseRPC::boolean(), SpawnOpts::list()) -&gt; pid()</pre>
<br></br>

Expand Down
20 changes: 0 additions & 20 deletions doc/contract_manager_tlog.md
View file
Expand Up @@ -33,88 +33,68 @@ error and event handling capabilities.</tt></pre>
###eventIn/5##




`eventIn(TLogMod_x, Msg, State, Mod, Status) -> any()`

<a name="eventOut-5"></a>

###eventOut/5##




`eventOut(TLogMod_x, Msg, State, Mod, Status) -> any()`

<a name="lpcIn-4"></a>

###lpcIn/4##




`lpcIn(TLogMod_x, Q, State, Mod) -> any()`

<a name="lpcOut-9"></a>

###lpcOut/9##




`lpcOut(TLogMod_x, StartTime, Q, State, Mod, Reply, NewState, NewMod, Status) -> any()`

<a name="lpcOutError-6"></a>

###lpcOutError/6##




`lpcOutError(TLogMod_x, StartTime, Q, State, Mod, Error) -> any()`

<a name="rpcFinish-1"></a>

###rpcFinish/1##




`rpcFinish(TLog) -> any()`

<a name="rpcIn-4"></a>

###rpcIn/4##




`rpcIn(TLogMod_x, Q, State, Mod) -> any()`

<a name="rpcOut-9"></a>

###rpcOut/9##




`rpcOut(TLogMod_x, StartTime, Q, State, Mod, Reply, NewState, NewMod, Status) -> any()`

<a name="rpcOutError-5"></a>

###rpcOutError/5##




`rpcOutError(TLogMod_x, Q, State, Mod, Error) -> any()`

<a name="rpcOutError-6"></a>

###rpcOutError/6##




`rpcOutError(TLogMod_x, StartTime, Q, State, Mod, Error) -> any()`

0 comments on commit ffd096a

Please sign in to comment.