Browse Source

minor documentation edits

git-svn-id: http://svn.ulf.wiger.net/gproc/branches/experimental-0906/gproc@37 f3948e33-8234-0410-8a80-a07eae3b6c4d
uwiger 15 years ago
parent
commit
75c322a90b
9 changed files with 25 additions and 13 deletions
  1. 11 6
      doc/gproc.html
  2. 1 1
      doc/gproc_app.html
  3. 1 1
      doc/gproc_dist.html
  4. 1 1
      doc/gproc_init.html
  5. 1 1
      doc/gproc_lib.html
  6. 1 1
      doc/gproc_sup.html
  7. 4 1
      doc/overview-summary.html
  8. 3 0
      doc/overview.edoc
  9. 2 1
      src/gproc.erl

+ 11 - 6
doc/gproc.html

@@ -12,11 +12,12 @@
 <ul class="index"><li><a href="#description">Description</a></li><li><a href="#types">Data Types</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>Extended process registry.
 
 <p><b>Behaviours:</b> <a href="gen_server.html"><tt>gen_server</tt></a>.</p>
-<p><b>Authors:</b> Ulf Wiger (<a href="mailto:ulf.wiger@ericsson.com"><tt>ulf.wiger@ericsson.com</tt></a>).</p>
+<p><b>Authors:</b> Ulf Wiger (<a href="mailto:ulf.wiger@erlang-consulting.com"><tt>ulf.wiger@erlang-consulting.com</tt></a>).</p>
 
 <h2><a name="description">Description</a></h2>Extended process registry
   <p>This module implements an extended process registry</p>
-  <p>For a detailed description, see gproc/doc/erlang07-wiger.pdf.</p>
+  <p>For a detailed description, see
+  <a href="erlang07-wiger.pdf">erlang07-wiger.pdf</a>.</p>
  
 <h2><a name="types">Data Types</a></h2>
 
@@ -81,7 +82,7 @@
 <tr><td valign="top"><a href="#lookup_local_properties-1">lookup_local_properties/1</a></td><td>Look up all local (non-unique) instances of a given Property.</td></tr>
 <tr><td valign="top"><a href="#lookup_pid-1">lookup_pid/1</a></td><td>Lookup the Pid stored with a key.</td></tr>
 <tr><td valign="top"><a href="#lookup_pids-1">lookup_pids/1</a></td><td>Returns a list of pids with the published key Key.</td></tr>
-<tr><td valign="top"><a href="#lookup_values-1">lookup_values/1</a></td><td></td></tr>
+<tr><td valign="top"><a href="#lookup_values-1">lookup_values/1</a></td><td>Retrieve the <code>{Pid,Value}</code> pairs corresponding to Key.</td></tr>
 <tr><td valign="top"><a href="#mreg-3">mreg/3</a></td><td>Register multiple {Key,Value} pairs of a given type and scope.</td></tr>
 <tr><td valign="top"><a href="#next-2">next/2</a></td><td>Behaves as ets:next(Tab,Key) for a given type of registration object.</td></tr>
 <tr><td valign="top"><a href="#prev-2">prev/2</a></td><td>Behaves as ets:prev(Tab,Key) for a given type of registration object.</td></tr>
@@ -261,8 +262,12 @@
 
 <h3 class="function"><a name="lookup_values-1">lookup_values/1</a></h3>
 <div class="spec">
-<p><tt>lookup_values(Key) -&gt; any()</tt></p>
-</div>
+<p><tt>lookup_values(Key::<a href="#type-key">key()</a>) -&gt; [{pid(), Value}]</tt></p>
+</div><p><p>Retrieve the <code>{Pid,Value}</code> pairs corresponding to Key.</p>
+ 
+  Key refer to any type of registry object. If it refers to a unique
+  object, the list will be of length 0 or 1. If it refers to a non-unique
+  object, the return value can be a list of any length.</p>
 
 <h3 class="function"><a name="mreg-3">mreg/3</a></h3>
 <div class="spec">
@@ -388,6 +393,6 @@ If it doesn't, this function will exit.</p>
 <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, Sep 21 2009, 10:14:31.</i></p>
+<p><i>Generated by EDoc, Sep 22 2009, 10:04:07.</i></p>
 </body>
 </html>

+ 1 - 1
doc/gproc_app.html

@@ -38,6 +38,6 @@
 <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, Sep 21 2009, 10:14:30.</i></p>
+<p><i>Generated by EDoc, Sep 22 2009, 10:04:07.</i></p>
 </body>
 </html>

+ 1 - 1
doc/gproc_dist.html

@@ -149,6 +149,6 @@
 <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, Sep 21 2009, 10:14:30.</i></p>
+<p><i>Generated by EDoc, Sep 22 2009, 10:04:07.</i></p>
 </body>
 </html>

+ 1 - 1
doc/gproc_init.html

@@ -31,6 +31,6 @@
 <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, Sep 21 2009, 10:14:30.</i></p>
+<p><i>Generated by EDoc, Sep 22 2009, 10:04:07.</i></p>
 </body>
 </html>

+ 1 - 1
doc/gproc_lib.html

@@ -18,6 +18,6 @@
   <p>For a detailed description, see gproc/doc/erlang07-wiger.pdf.</p><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, Sep 21 2009, 10:14:31.</i></p>
+<p><i>Generated by EDoc, Sep 22 2009, 10:04:07.</i></p>
 </body>
 </html>

+ 1 - 1
doc/gproc_sup.html

@@ -32,6 +32,6 @@
 <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, Sep 21 2009, 10:14:31.</i></p>
+<p><i>Generated by EDoc, Sep 22 2009, 10:04:07.</i></p>
 </body>
 </html>

+ 4 - 1
doc/overview-summary.html

@@ -11,6 +11,9 @@
 Extended process dictionary
 <h2>Introduction</h2>
 
+<p>Gproc was first introduced at the ACM SIGPLAN Erlang Workshop in
+Freiburg 2007 (<a href="erlang07-wiger.pdf">Paper available here</a>).</p>
+
 <p>This application was designed to meet the following requirements:</p>
 
 <p><li>
@@ -32,6 +35,6 @@ express a strong urge to use this functionality.</em>
 
 <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, Sep 21 2009, 10:14:31.</i></p>
+<p><i>Generated by EDoc, Sep 22 2009, 10:04:07.</i></p>
 </body>
 </html>

+ 3 - 0
doc/overview.edoc

@@ -4,6 +4,9 @@
 @doc Extended process dictionary
 <h2>Introduction</h2>
 
+Gproc was first introduced at the ACM SIGPLAN Erlang Workshop in
+Freiburg 2007 (<a href="erlang07-wiger.pdf">Paper available here</a>).
+
 This application was designed to meet the following requirements:
 
 <li>

+ 2 - 1
src/gproc.erl

@@ -17,7 +17,8 @@
 %%
 %% @doc Extended process registry
 %% <p>This module implements an extended process registry</p>
-%% <p>For a detailed description, see gproc/doc/erlang07-wiger.pdf.</p>
+%% <p>For a detailed description, see
+%% <a href="erlang07-wiger.pdf">erlang07-wiger.pdf</a>.</p>
 %%
 %% @type type()  = n | p | c | a. n = name; p = property; c = counter; 
 %%                                a = aggregate_counter