Skip to content

Commit

Permalink
rebuilt documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
uwiger committed Jul 21, 2016
1 parent 78db51e commit 4824309
Show file tree
Hide file tree
Showing 4 changed files with 54 additions and 3 deletions.
26 changes: 26 additions & 0 deletions README.md
Expand Up @@ -22,6 +22,13 @@ actively use either, they are no longer fetched by default.



## Installation ##

You can get `gproc` from the [Hex package manager](https://hex.pm/packages/gproc)

That means declaring dependency on `{gproc, "0.5.0"}` in your `rebar3`-based applications or `{:gproc, "~> 0.5.0"}` in your `mix` based applications.


## Introduction ##

Gproc is a process dictionary for Erlang, which provides a number of useful features beyond what the built-in dictionary has:
Expand Down Expand Up @@ -102,3 +109,22 @@ If you want to change this, remove the `edoc_opts` line from `rebar.config`.

Gproc was first introduced at the ACM SIGPLAN Erlang Workshop in
Freiburg 2007 ([Paper available here](http://github.com/uwiger/gproc/blob/master/doc/erlang07-wiger.pdf)).


## Modules ##


<table width="100%" border="0" summary="list of modules">
<tr><td><a href="http://github.com/uwiger/gproc/blob/master/doc/gproc.md" class="module">gproc</a></td></tr>
<tr><td><a href="http://github.com/uwiger/gproc/blob/master/doc/gproc_app.md" class="module">gproc_app</a></td></tr>
<tr><td><a href="http://github.com/uwiger/gproc/blob/master/doc/gproc_bcast.md" class="module">gproc_bcast</a></td></tr>
<tr><td><a href="http://github.com/uwiger/gproc/blob/master/doc/gproc_dist.md" class="module">gproc_dist</a></td></tr>
<tr><td><a href="http://github.com/uwiger/gproc/blob/master/doc/gproc_info.md" class="module">gproc_info</a></td></tr>
<tr><td><a href="http://github.com/uwiger/gproc/blob/master/doc/gproc_init.md" class="module">gproc_init</a></td></tr>
<tr><td><a href="http://github.com/uwiger/gproc/blob/master/doc/gproc_lib.md" class="module">gproc_lib</a></td></tr>
<tr><td><a href="http://github.com/uwiger/gproc/blob/master/doc/gproc_monitor.md" class="module">gproc_monitor</a></td></tr>
<tr><td><a href="http://github.com/uwiger/gproc/blob/master/doc/gproc_pool.md" class="module">gproc_pool</a></td></tr>
<tr><td><a href="http://github.com/uwiger/gproc/blob/master/doc/gproc_ps.md" class="module">gproc_ps</a></td></tr>
<tr><td><a href="http://github.com/uwiger/gproc/blob/master/doc/gproc_pt.md" class="module">gproc_pt</a></td></tr>
<tr><td><a href="http://github.com/uwiger/gproc/blob/master/doc/gproc_sup.md" class="module">gproc_sup</a></td></tr></table>

26 changes: 26 additions & 0 deletions doc/README.md
Expand Up @@ -22,6 +22,13 @@ actively use either, they are no longer fetched by default.



## Installation ##

You can get `gproc` from the [Hex package manager](https://hex.pm/packages/gproc)

That means declaring dependency on `{gproc, "0.5.0"}` in your `rebar3`-based applications or `{:gproc, "~> 0.5.0"}` in your `mix` based applications.


## Introduction ##

Gproc is a process dictionary for Erlang, which provides a number of useful features beyond what the built-in dictionary has:
Expand Down Expand Up @@ -102,3 +109,22 @@ If you want to change this, remove the `edoc_opts` line from `rebar.config`.

Gproc was first introduced at the ACM SIGPLAN Erlang Workshop in
Freiburg 2007 ([Paper available here](erlang07-wiger.pdf)).


## Modules ##


<table width="100%" border="0" summary="list of modules">
<tr><td><a href="gproc.md" class="module">gproc</a></td></tr>
<tr><td><a href="gproc_app.md" class="module">gproc_app</a></td></tr>
<tr><td><a href="gproc_bcast.md" class="module">gproc_bcast</a></td></tr>
<tr><td><a href="gproc_dist.md" class="module">gproc_dist</a></td></tr>
<tr><td><a href="gproc_info.md" class="module">gproc_info</a></td></tr>
<tr><td><a href="gproc_init.md" class="module">gproc_init</a></td></tr>
<tr><td><a href="gproc_lib.md" class="module">gproc_lib</a></td></tr>
<tr><td><a href="gproc_monitor.md" class="module">gproc_monitor</a></td></tr>
<tr><td><a href="gproc_pool.md" class="module">gproc_pool</a></td></tr>
<tr><td><a href="gproc_ps.md" class="module">gproc_ps</a></td></tr>
<tr><td><a href="gproc_pt.md" class="module">gproc_pt</a></td></tr>
<tr><td><a href="gproc_sup.md" class="module">gproc_sup</a></td></tr></table>

1 change: 0 additions & 1 deletion doc/edoc-info
@@ -1,5 +1,4 @@
%% encoding: UTF-8
{application,gproc}.
{packages,[]}.
{modules,[gproc,gproc_app,gproc_bcast,gproc_dist,gproc_info,gproc_init,
gproc_lib,gproc_monitor,gproc_pool,gproc_ps,gproc_pt,gproc_sup]}.
4 changes: 2 additions & 2 deletions doc/stylesheet.css
Expand Up @@ -27,10 +27,10 @@ div.spec {
margin-left: 2em;
background-color: #eeeeee;
}
a.module,a.package {
a.module {
text-decoration:none
}
a.module:hover,a.package:hover {
a.module:hover {
background-color: #eeeeee;
}
ul.definitions {
Expand Down

0 comments on commit 4824309

Please sign in to comment.