Permalink
Browse files

Update edoc

  • Loading branch information...
1 parent 4135ffa commit 0d8db1c0407664831f9262ac801392b57f537029 @engelsanchez engelsanchez committed Feb 14, 2013
Showing with 2,072 additions and 546 deletions.
  1. +20 −1 app_helper.html
  2. +2 −1 bloom.html
  3. +2 −1 chash.html
  4. +14 −9 edoc-info
  5. +2 −1 gen_nb_server.html
  6. +2 −1 json_pp.html
  7. +2 −1 merkerl.html
  8. +14 −4 modules-frame.html
  9. +2 −1 overview-summary.html
  10. +2 −1 process_proxy.html
  11. +27 −5 riak_core.html
  12. +2 −1 riak_core_apl.html
  13. +9 −2 riak_core_app.html
  14. +28 −1 riak_core_bucket.html
  15. +173 −0 riak_core_capability.html
  16. +2 −1 riak_core_cinfo_core.html
  17. +116 −1 riak_core_claim.html
  18. +22 −0 riak_core_claim_sim.html
  19. +250 −0 riak_core_claim_util.html
  20. +168 −0 riak_core_claimant.html
  21. +2 −1 riak_core_config.html
  22. +57 −2 riak_core_console.html
  23. +3 −1 riak_core_coverage_fsm.html
  24. +2 −1 riak_core_coverage_plan.html
  25. +113 −0 riak_core_dtrace.html
  26. +2 −1 riak_core_eventhandler_guard.html
  27. +2 −1 riak_core_eventhandler_sup.html
  28. +2 −1 riak_core_format.html
  29. +5 −3 gen_server2.html → riak_core_gen_server.html
  30. +22 −5 riak_core_gossip.html
  31. +2 −1 riak_core_gossip_legacy.html
  32. +8 −1 riak_core_handoff_listener.html
  33. +2 −1 riak_core_handoff_listener_sup.html
  34. +42 −7 riak_core_handoff_manager.html
  35. +3 −2 riak_core_handoff_receiver.html
  36. +2 −1 riak_core_handoff_receiver_sup.html
  37. +3 −2 riak_core_handoff_sender.html
  38. +34 −7 riak_core_handoff_sender_sup.html
  39. +2 −1 riak_core_handoff_sup.html
  40. +2 −1 riak_core_new_claim.html
  41. +83 −3 riak_core_node_watcher.html
  42. +2 −1 riak_core_node_watcher_events.html
  43. +2 −1 riak_core_nodeid.html
  44. +4 −3 priority_queue.html → riak_core_priority_queue.html
  45. +90 −0 riak_core_repair.html
  46. +84 −3 riak_core_ring.html
  47. +2 −1 riak_core_ring_events.html
  48. +2 −1 riak_core_ring_handler.html
  49. +3 −2 riak_core_ring_manager.html
  50. +9 −2 riak_core_ring_util.html
  51. +57 −12 riak_core_stat.html
  52. +92 −0 riak_core_stat_cache.html
  53. +80 −0 riak_core_stat_calc_proc.html
  54. +51 −0 riak_core_stat_calc_sup.html
  55. +39 −0 riak_core_stat_q.html
  56. +38 −0 riak_core_stat_sup.html
  57. +50 −0 riak_core_stats_sup.html
  58. +2 −1 riak_core_status.html
  59. +14 −1 riak_core_sup.html
  60. +2 −25 riak_core_sysmon_handler.html
  61. +2 −1 riak_core_sysmon_minder.html
  62. +2 −1 riak_core_test_util.html
  63. +2 −1 riak_core_tracer.html
  64. +76 −1 riak_core_util.html
  65. +3 −1 riak_core_vnode.html
  66. +43 −2 riak_core_vnode_manager.html
  67. +2 −1 riak_core_vnode_master.html
  68. +3 −2 riak_core_vnode_proxy.html
  69. +2 −1 riak_core_vnode_proxy_sup.html
  70. +2 −1 riak_core_vnode_sup.html
  71. +10 −2 riak_core_vnode_worker.html
  72. +2 −1 riak_core_vnode_worker_pool.html
  73. +2 −1 riak_core_web.html
  74. +2 −1 riak_core_wm_urlmap.html
  75. +0 −192 slide.html
  76. +0 −93 spiraltime.html
  77. +39 −114 stylesheet.css
  78. +3 −1 supervisor_pre_r14b04.html
  79. +2 −1 vclock.html
View
@@ -1,6 +1,7 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Module app_helper</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
</head>
@@ -20,6 +21,9 @@
return from the application's env.</td></tr>
<tr><td valign="top"><a href="#get_prop_or_env-4">get_prop_or_env/4</a></td><td>Return the value for Key in Properties if it exists, otherwise return
the value from the application's env, or Default.</td></tr>
+<tr><td valign="top"><a href="#try_envs-1">try_envs/1</a></td><td></td></tr>
+<tr><td valign="top"><a href="#try_envs-2">try_envs/2</a></td><td>Like <code>get_env</code> but try multiple <code>{App, Key}</code> combos before
+ returning <code>{default, Default}</code>.</td></tr>
</table>
<h2><a name="functions">Function Details</a></h2>
@@ -52,9 +56,24 @@ <h3 class="function"><a name="get_prop_or_env-4">get_prop_or_env/4</a></h3>
<p><tt>get_prop_or_env(Key::atom(), Properties::[{atom(), term()}], App::atom(), Default::term()) -&gt; term()</tt><br></p>
</div><p>Return the value for Key in Properties if it exists, otherwise return
the value from the application's env, or Default.</p>
+
+<h3 class="function"><a name="try_envs-1">try_envs/1</a></h3>
+<div class="spec">
+<p><tt>try_envs(Pairs) -&gt; any()</tt></p>
+</div>
+
+<h3 class="function"><a name="try_envs-2">try_envs/2</a></h3>
+<div class="spec">
+<p><tt>try_envs(T::[{atom(), atom()}], Default::term()) -&gt; {atom(), atom(), term()}</tt><br></p>
+</div><p>Like <code>get_env</code> but try multiple <code>{App, Key}</code> combos before
+ returning <code>{default, Default}</code>. The return value is <code>{App,
+ Key, Value}</code> so that the caller may distinguish where the
+ value came from. This is useful for scenarios when the config
+ app/key has changed between releases and you need to check for
+ both.</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, Apr 27 2012, 16:05:07.</i></p>
+<p><i>Generated by EDoc, Feb 14 2013, 15:00:15.</i></p>
</body>
</html>
View
@@ -1,6 +1,7 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Module bloom</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
</head>
@@ -91,6 +92,6 @@ <h3 class="function"><a name="size-1">size/1</a></h3>
<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, Apr 27 2012, 16:05:07.</i></p>
+<p><i>Generated by EDoc, Feb 14 2013, 15:00:15.</i></p>
</body>
</html>
View
@@ -1,6 +1,7 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Module chash</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
</head>
@@ -167,6 +168,6 @@ <h3 class="function"><a name="update-3">update/3</a></h3>
<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, Apr 27 2012, 16:05:07.</i></p>
+<p><i>Generated by EDoc, Feb 14 2013, 15:00:15.</i></p>
</body>
</html>
View
@@ -1,22 +1,27 @@
{application,riak_core}.
{packages,[]}.
-{modules,[app_helper,bloom,chash,gen_nb_server,gen_server2,json_pp,merkerl,
- priority_queue,process_proxy,riak_core,riak_core_apl,riak_core_app,
- riak_core_bucket,riak_core_cinfo_core,riak_core_claim,
+{modules,[app_helper,bloom,chash,gen_nb_server,json_pp,merkerl,process_proxy,
+ riak_core,riak_core_apl,riak_core_app,riak_core_bucket,
+ riak_core_capability,riak_core_cinfo_core,riak_core_claim,
+ riak_core_claim_sim,riak_core_claim_util,riak_core_claimant,
riak_core_config,riak_core_console,riak_core_coverage_fsm,
- riak_core_coverage_plan,riak_core_eventhandler_guard,
- riak_core_eventhandler_sup,riak_core_format,riak_core_gossip,
+ riak_core_coverage_plan,riak_core_dtrace,
+ riak_core_eventhandler_guard,riak_core_eventhandler_sup,
+ riak_core_format,riak_core_gen_server,riak_core_gossip,
riak_core_gossip_legacy,riak_core_handoff_listener,
riak_core_handoff_listener_sup,riak_core_handoff_manager,
riak_core_handoff_receiver,riak_core_handoff_receiver_sup,
riak_core_handoff_sender,riak_core_handoff_sender_sup,
riak_core_handoff_sup,riak_core_new_claim,riak_core_node_watcher,
- riak_core_node_watcher_events,riak_core_nodeid,riak_core_ring,
+ riak_core_node_watcher_events,riak_core_nodeid,
+ riak_core_priority_queue,riak_core_repair,riak_core_ring,
riak_core_ring_events,riak_core_ring_handler,riak_core_ring_manager,
- riak_core_ring_util,riak_core_stat,riak_core_status,riak_core_sup,
- riak_core_sysmon_handler,riak_core_sysmon_minder,
+ riak_core_ring_util,riak_core_stat,riak_core_stat_cache,
+ riak_core_stat_calc_proc,riak_core_stat_calc_sup,riak_core_stat_q,
+ riak_core_stat_sup,riak_core_stats_sup,riak_core_status,
+ riak_core_sup,riak_core_sysmon_handler,riak_core_sysmon_minder,
riak_core_test_util,riak_core_tracer,riak_core_util,riak_core_vnode,
riak_core_vnode_manager,riak_core_vnode_master,
riak_core_vnode_proxy,riak_core_vnode_proxy_sup,riak_core_vnode_sup,
riak_core_vnode_worker,riak_core_vnode_worker_pool,riak_core_web,
- riak_core_wm_urlmap,slide,spiraltime,supervisor_pre_r14b04,vclock]}.
+ riak_core_wm_urlmap,supervisor_pre_r14b04,vclock]}.
View
@@ -1,6 +1,7 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Module gen_nb_server</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
</head>
@@ -27,6 +28,6 @@ <h3 class="function"><a name="start_link-4">start_link/4</a></h3>
<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, Apr 27 2012, 16:05:07.</i></p>
+<p><i>Generated by EDoc, Feb 14 2013, 15:00:15.</i></p>
</body>
</html>
View
@@ -1,6 +1,7 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Module json_pp</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
</head>
@@ -31,6 +32,6 @@ <h3 class="function"><a name="test-0">test/0</a></h3>
<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, Apr 27 2012, 16:05:07.</i></p>
+<p><i>Generated by EDoc, Feb 14 2013, 15:00:15.</i></p>
</body>
</html>
View
@@ -1,6 +1,7 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Module merkerl</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
</head>
@@ -118,6 +119,6 @@ <h3 class="function"><a name="insert-2">insert/2</a></h3>
<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, Apr 27 2012, 16:05:07.</i></p>
+<p><i>Generated by EDoc, Feb 14 2013, 15:00:15.</i></p>
</body>
</html>
View
@@ -11,24 +11,28 @@ <h2 class="indextitle">Modules</h2>
<tr><td><a href="bloom.html" target="overviewFrame" class="module">bloom</a></td></tr>
<tr><td><a href="chash.html" target="overviewFrame" class="module">chash</a></td></tr>
<tr><td><a href="gen_nb_server.html" target="overviewFrame" class="module">gen_nb_server</a></td></tr>
-<tr><td><a href="gen_server2.html" target="overviewFrame" class="module">gen_server2</a></td></tr>
<tr><td><a href="json_pp.html" target="overviewFrame" class="module">json_pp</a></td></tr>
<tr><td><a href="merkerl.html" target="overviewFrame" class="module">merkerl</a></td></tr>
-<tr><td><a href="priority_queue.html" target="overviewFrame" class="module">priority_queue</a></td></tr>
<tr><td><a href="process_proxy.html" target="overviewFrame" class="module">process_proxy</a></td></tr>
<tr><td><a href="riak_core.html" target="overviewFrame" class="module">riak_core</a></td></tr>
<tr><td><a href="riak_core_apl.html" target="overviewFrame" class="module">riak_core_apl</a></td></tr>
<tr><td><a href="riak_core_app.html" target="overviewFrame" class="module">riak_core_app</a></td></tr>
<tr><td><a href="riak_core_bucket.html" target="overviewFrame" class="module">riak_core_bucket</a></td></tr>
+<tr><td><a href="riak_core_capability.html" target="overviewFrame" class="module">riak_core_capability</a></td></tr>
<tr><td><a href="riak_core_cinfo_core.html" target="overviewFrame" class="module">riak_core_cinfo_core</a></td></tr>
<tr><td><a href="riak_core_claim.html" target="overviewFrame" class="module">riak_core_claim</a></td></tr>
+<tr><td><a href="riak_core_claim_sim.html" target="overviewFrame" class="module">riak_core_claim_sim</a></td></tr>
+<tr><td><a href="riak_core_claim_util.html" target="overviewFrame" class="module">riak_core_claim_util</a></td></tr>
+<tr><td><a href="riak_core_claimant.html" target="overviewFrame" class="module">riak_core_claimant</a></td></tr>
<tr><td><a href="riak_core_config.html" target="overviewFrame" class="module">riak_core_config</a></td></tr>
<tr><td><a href="riak_core_console.html" target="overviewFrame" class="module">riak_core_console</a></td></tr>
<tr><td><a href="riak_core_coverage_fsm.html" target="overviewFrame" class="module">riak_core_coverage_fsm</a></td></tr>
<tr><td><a href="riak_core_coverage_plan.html" target="overviewFrame" class="module">riak_core_coverage_plan</a></td></tr>
+<tr><td><a href="riak_core_dtrace.html" target="overviewFrame" class="module">riak_core_dtrace</a></td></tr>
<tr><td><a href="riak_core_eventhandler_guard.html" target="overviewFrame" class="module">riak_core_eventhandler_guard</a></td></tr>
<tr><td><a href="riak_core_eventhandler_sup.html" target="overviewFrame" class="module">riak_core_eventhandler_sup</a></td></tr>
<tr><td><a href="riak_core_format.html" target="overviewFrame" class="module">riak_core_format</a></td></tr>
+<tr><td><a href="riak_core_gen_server.html" target="overviewFrame" class="module">riak_core_gen_server</a></td></tr>
<tr><td><a href="riak_core_gossip.html" target="overviewFrame" class="module">riak_core_gossip</a></td></tr>
<tr><td><a href="riak_core_gossip_legacy.html" target="overviewFrame" class="module">riak_core_gossip_legacy</a></td></tr>
<tr><td><a href="riak_core_handoff_listener.html" target="overviewFrame" class="module">riak_core_handoff_listener</a></td></tr>
@@ -43,12 +47,20 @@ <h2 class="indextitle">Modules</h2>
<tr><td><a href="riak_core_node_watcher.html" target="overviewFrame" class="module">riak_core_node_watcher</a></td></tr>
<tr><td><a href="riak_core_node_watcher_events.html" target="overviewFrame" class="module">riak_core_node_watcher_events</a></td></tr>
<tr><td><a href="riak_core_nodeid.html" target="overviewFrame" class="module">riak_core_nodeid</a></td></tr>
+<tr><td><a href="riak_core_priority_queue.html" target="overviewFrame" class="module">riak_core_priority_queue</a></td></tr>
+<tr><td><a href="riak_core_repair.html" target="overviewFrame" class="module">riak_core_repair</a></td></tr>
<tr><td><a href="riak_core_ring.html" target="overviewFrame" class="module">riak_core_ring</a></td></tr>
<tr><td><a href="riak_core_ring_events.html" target="overviewFrame" class="module">riak_core_ring_events</a></td></tr>
<tr><td><a href="riak_core_ring_handler.html" target="overviewFrame" class="module">riak_core_ring_handler</a></td></tr>
<tr><td><a href="riak_core_ring_manager.html" target="overviewFrame" class="module">riak_core_ring_manager</a></td></tr>
<tr><td><a href="riak_core_ring_util.html" target="overviewFrame" class="module">riak_core_ring_util</a></td></tr>
<tr><td><a href="riak_core_stat.html" target="overviewFrame" class="module">riak_core_stat</a></td></tr>
+<tr><td><a href="riak_core_stat_cache.html" target="overviewFrame" class="module">riak_core_stat_cache</a></td></tr>
+<tr><td><a href="riak_core_stat_calc_proc.html" target="overviewFrame" class="module">riak_core_stat_calc_proc</a></td></tr>
+<tr><td><a href="riak_core_stat_calc_sup.html" target="overviewFrame" class="module">riak_core_stat_calc_sup</a></td></tr>
+<tr><td><a href="riak_core_stat_q.html" target="overviewFrame" class="module">riak_core_stat_q</a></td></tr>
+<tr><td><a href="riak_core_stat_sup.html" target="overviewFrame" class="module">riak_core_stat_sup</a></td></tr>
+<tr><td><a href="riak_core_stats_sup.html" target="overviewFrame" class="module">riak_core_stats_sup</a></td></tr>
<tr><td><a href="riak_core_status.html" target="overviewFrame" class="module">riak_core_status</a></td></tr>
<tr><td><a href="riak_core_sup.html" target="overviewFrame" class="module">riak_core_sup</a></td></tr>
<tr><td><a href="riak_core_sysmon_handler.html" target="overviewFrame" class="module">riak_core_sysmon_handler</a></td></tr>
@@ -66,8 +78,6 @@ <h2 class="indextitle">Modules</h2>
<tr><td><a href="riak_core_vnode_worker_pool.html" target="overviewFrame" class="module">riak_core_vnode_worker_pool</a></td></tr>
<tr><td><a href="riak_core_web.html" target="overviewFrame" class="module">riak_core_web</a></td></tr>
<tr><td><a href="riak_core_wm_urlmap.html" target="overviewFrame" class="module">riak_core_wm_urlmap</a></td></tr>
-<tr><td><a href="slide.html" target="overviewFrame" class="module">slide</a></td></tr>
-<tr><td><a href="spiraltime.html" target="overviewFrame" class="module">spiraltime</a></td></tr>
<tr><td><a href="supervisor_pre_r14b04.html" target="overviewFrame" class="module">supervisor_pre_r14b04</a></td></tr>
<tr><td><a href="vclock.html" target="overviewFrame" class="module">vclock</a></td></tr></table>
</body>
View
@@ -1,6 +1,7 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>The riak_core application</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
</head>
@@ -10,6 +11,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, Apr 27 2012, 16:05:07.</i></p>
+<p><i>Generated by EDoc, Feb 14 2013, 15:00:15.</i></p>
</body>
</html>
View
@@ -1,6 +1,7 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Module process_proxy</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
</head>
@@ -37,6 +38,6 @@ <h3 class="function"><a name="stop-1">stop/1</a></h3>
<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, Apr 27 2012, 16:05:07.</i></p>
+<p><i>Generated by EDoc, Feb 14 2013, 15:00:15.</i></p>
</body>
</html>
Oops, something went wrong.

0 comments on commit 0d8db1c

Please sign in to comment.