Permalink
Browse files

Update master docs

  • Loading branch information...
josevalim committed Dec 31, 2012
1 parent 0c0b7d2 commit f55ddf563c76d265bcde19722633d7e21ca046bf
Showing with 3,294 additions and 7,297 deletions.
  1. +22 −1 docs/master/Access.Binary.Dict.html
  2. +22 −1 docs/master/Access.HashDict.html
  3. +22 −1 docs/master/Access.Orddict.html
  4. +100 −0 docs/master/Application.Behaviour.html
  5. +1 −110 docs/master/ArgumentError.html
  6. +1 −110 docs/master/ArithmeticError.html
  7. +2 −134 docs/master/BadArityError.html
  8. +2 −101 docs/master/BadFunctionError.html
  9. +0 −11 docs/master/Behaviour.html
  10. +0 −143 docs/master/Binary.Dict.html
  11. +22 −1 docs/master/Binary.Inspect.Any.html
  12. +22 −1 docs/master/Binary.Inspect.Atom.html
  13. +22 −1 docs/master/Binary.Inspect.BitString.html
  14. +22 −1 docs/master/Binary.Inspect.List.html
  15. +22 −1 docs/master/Binary.Inspect.Number.html
  16. +22 −1 docs/master/Binary.Inspect.Regex.html
  17. +22 −1 docs/master/Binary.Inspect.Tuple.html
  18. +2 −101 docs/master/CaseClauseError.html
  19. +83 −0 docs/master/Code.LoadError.html
  20. +18 −18 docs/master/Code.html
  21. +2 −167 docs/master/CompileError.html
  22. +47 −17 docs/master/Dict.html
  23. +33 −1 docs/master/Enum.Iterator.Binary.Dict.html
  24. +33 −1 docs/master/Enum.Iterator.Function.html
  25. +33 −1 docs/master/Enum.Iterator.HashDict.html
  26. +33 −1 docs/master/Enum.Iterator.List.html
  27. +33 −1 docs/master/Enum.Iterator.Orddict.html
  28. +32 −0 docs/master/Enum.Iterator.Range.html
  29. +1 −110 docs/master/Enum.OutOfBoundsError.html
  30. +8 −8 docs/master/Enum.html
  31. +2 −101 docs/master/ErlangError.html
  32. +89 −15 docs/master/ExUnit.Assertions.html
  33. +29 −29 docs/master/ExUnit.CLIFormatter.html
  34. +338 −0 docs/master/ExUnit.ExpectationError.html
  35. +24 −24 docs/master/ExUnit.Formatter.html
  36. +51 −31 docs/master/ExUnit.html
  37. +46 −30 docs/master/Exception.html
  38. +0 −198 docs/master/File.CopyError.html
  39. +0 −165 docs/master/File.Error.html
  40. +0 −99 docs/master/File.IteratorError.html
  41. +0 −483 docs/master/File.Stat.html
  42. +2 −167 docs/master/FunctionClauseError.html
  43. +67 −21 docs/master/GenServer.Behaviour.html
  44. +7 −7 docs/master/IEx.Helpers.html
  45. +3 −3 docs/master/IO.html
  46. +146 −22 docs/master/Kernel.SpecialForms.html
  47. +13 −13 docs/master/Kernel.Typespec.html
  48. +89 −64 docs/master/Kernel.html
  49. +2 −101 docs/master/KeyError.html
  50. +26 −7 docs/master/Keyword.html
  51. +21 −0 docs/master/List.Chars.Atom.html
  52. +21 −0 docs/master/List.Chars.BitString.html
  53. +21 −0 docs/master/List.Chars.List.html
  54. +21 −0 docs/master/List.Chars.Number.html
  55. +3 −3 docs/master/List.html
  56. +29 −352 docs/master/Macro.Env.html
  57. +12 −11 docs/master/Macro.html
  58. +2 −101 docs/master/MatchError.html
  59. +0 −101 docs/master/Mix.Deps.Lock.html
  60. +0 −11 docs/master/Mix.Error.html
  61. +0 −11 docs/master/Mix.InvalidTaskError.html
  62. +0 −11 docs/master/Mix.NoProjectError.html
  63. +0 −11 docs/master/Mix.NoTaskError.html
  64. +0 −11 docs/master/Mix.OutOfDateDepsError.html
  65. +17 −5 docs/master/Mix.Project.html
  66. +83 −0 docs/master/Mix.Tasks.App.Start.html
  67. +5 −5 docs/master/Mix.Tasks.Compile.App.html
  68. +7 −7 docs/master/Mix.Tasks.Compile.Elixir.html
  69. +9 −7 docs/master/Mix.Tasks.Compile.html
  70. +2 −9 docs/master/Mix.Tasks.Deps.Compile.html
  71. +9 −2 docs/master/Mix.Tasks.Iex.html
  72. +13 −3 docs/master/Mix.Tasks.New.html
  73. +3 −1 docs/master/Mix.Tasks.Run.html
  74. +10 −1 docs/master/Mix.Tasks.Test.html
  75. +8 −8 docs/master/Mix.Utils.html
  76. +11 −12 docs/master/Mix.html
  77. +13 −13 docs/master/Node.html
  78. +15 −8 docs/master/OptionParser.html
  79. +34 −36 docs/master/Process.html
  80. +2 −134 docs/master/Protocol.UndefinedError.html
  81. +32 −0 docs/master/Range.Iterator.Number.html
  82. +0 −120 docs/master/Range.html
  83. +3 −3 docs/master/Record.html
  84. +0 −109 docs/master/Regex.CompileError.html
  85. +1 −110 docs/master/RuntimeError.html
  86. +63 −20 docs/master/String.html
  87. +272 −0 docs/master/Supervisor.Behaviour.html
  88. +2 −167 docs/master/SyntaxError.html
  89. +8 −4 docs/master/System.html
  90. +1 −110 docs/master/SystemLimitError.html
  91. +2 −167 docs/master/TokenMissingError.html
  92. +2 −167 docs/master/UndefinedFunctionError.html
  93. +163 −148 docs/master/modules_list.html
  94. +197 −1 docs/master/protocols_list.html
  95. +559 −2,672 docs/master/records_list.html
@@ -29,21 +29,42 @@ <h1>
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/binary/dict.ex#L86" target="_blank" class="view_source">Source</a>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/binary/dict.ex#L105" target="_blank" class="view_source">Source</a>
+ <h2>Functions summary</h2>
+ <ul class="summary">
+ <li>
+ <span class="summary_signature">
+ <a href="#access/2">access/2</a>
+ </span>
+</li>
+ </ul>
+ <div id="functions_details" class="details_list">
+ <h2>Functions</h2>
+ <div class="detail">
+ <p class="signature" id="access/2">
+ <strong>access(dict, key)</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/binary/dict.ex#L106" target="_blank" class="view_source">Source</a>
+</div>
+ </div>
+
+
+
</div>
@@ -29,21 +29,42 @@ <h1>
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/hash_dict.ex#L103" target="_blank" class="view_source">Source</a>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/hash_dict.ex#L108" target="_blank" class="view_source">Source</a>
+ <h2>Functions summary</h2>
+ <ul class="summary">
+ <li>
+ <span class="summary_signature">
+ <a href="#access/2">access/2</a>
+ </span>
+</li>
+ </ul>
+ <div id="functions_details" class="details_list">
+ <h2>Functions</h2>
+ <div class="detail">
+ <p class="signature" id="access/2">
+ <strong>access(dict, key)</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/hash_dict.ex#L109" target="_blank" class="view_source">Source</a>
+</div>
+ </div>
+
+
+
</div>
@@ -29,21 +29,42 @@ <h1>
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/ord_dict.ex#L101" target="_blank" class="view_source">Source</a>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/ord_dict.ex#L106" target="_blank" class="view_source">Source</a>
+ <h2>Functions summary</h2>
+ <ul class="summary">
+ <li>
+ <span class="summary_signature">
+ <a href="#access/2">access/2</a>
+ </span>
+</li>
+ </ul>
+ <div id="functions_details" class="details_list">
+ <h2>Functions</h2>
+ <div class="detail">
+ <p class="signature" id="access/2">
+ <strong>access(dict, key)</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/ord_dict.ex#L107" target="_blank" class="view_source">Source</a>
+</div>
+ </div>
+
+
+
</div>
@@ -0,0 +1,100 @@
+<!DOCTYPE html>
+<html>
+ <head>
+ <title>Application.Behaviour</title>
+ <meta charset="utf-8">
+ <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
+
+ <script type="text/javascript" charset="utf-8">
+ relpath = '';
+ if (relpath != '') relpath += '/';
+ </script>
+
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+ </head>
+
+ <body>
+ <script type="text/javascript" charset="utf-8">
+ if (window.top.frames.main) document.body.className = 'frames';
+ </script>
+
+ <div id="content">
+ <h1>
+ Application.Behaviour
+
+ </h1>
+
+
+ <div id="moduledoc" class="docstring">
+ <p>This module is a convenience to define application module callbacks.</p>
+
+<p>In Erlang/OTP, an application is a component that can be started
+and stopped as a unit, and which can be re-used in other systems
+as well.</p>
+
+<p>The first step to achieve this is to define an application specification.
+For example, if your application is named <code>:my_app</code>, an app specification
+should exist at <code>ebin/my_app.app</code>. This file is usually defined by
+build tools like Mix.</p>
+
+<p>Then, with the app specification in hands, we must also define an
+application module callback that controls how to start and stop
+such applications. This module is about defining such callbacks.</p>
+
+<p>There are two callbacks required to be implemented:</p>
+
+<ol>
+<li><p><code>start(type, args)</code> - It must return <code>{ :ok, pid }</code> or
+<code>{ :ok, pid, state }</code>, where <code>pid</code> is the process identifier
+of the supervisor tree root;</p></li>
+<li><p><code>stop(state)</code> receives the state returned by <code>start</code> and should
+do any necessary cleaning up. Notice that shutting down the supervisor
+is automatically handled by the VM;</p></li>
+</ol>
+
+<p>When using this module, it simply tags the module behaviour as
+<code>:application</code> and defines a default <code>stop/1</code> callback. The <code>start/2</code>
+still needs to be defined by the user.</p>
+
+<p>You can learn more about the <code>:application</code> module, the application
+specification and the application module callbacks below:</p>
+
+<p><a href="http://www.erlang.org/doc/man/application.html">http://www.erlang.org/doc/man/application.html</a>
+<a href="http://www.erlang.org/doc/design_principles/applications.html">http://www.erlang.org/doc/design_principles/applications.html</a>
+<a href="http://learnyousomeerlang.com/building-otp-applications">http://learnyousomeerlang.com/building-otp-applications</a></p>
+
+<h2>Example</h2>
+
+<pre><code>defmodule MyApp do
+ use Application.Behaviour
+
+ def start(_type, args) do
+ MyApp.Sup.start_link(args)
+ end
+end
+</code></pre>
+
+ </div>
+
+
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/application/behaviour.ex#L1" target="_blank" class="view_source">Source</a>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </body>
+</html>
@@ -29,7 +29,7 @@ <h1>
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/exception.ex#L156" target="_blank" class="view_source">Source</a>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/exception.ex#L171" target="_blank" class="view_source">Source</a>
@@ -47,123 +47,14 @@ <h2>Fields <small>(and defaults)</small></h2>
- <h2>Functions summary</h2>
- <ul class="summary">
- <li>
- <span class="summary_signature">
- <a href="#exception/1">exception/1</a>
- </span>
-</li>
-<li>
- <span class="summary_signature">
- <a href="#exception/2">exception/2</a>
- </span>
-</li>
-<li>
- <span class="summary_signature">
- <a href="#message/1">message/1</a>
- </span>
-</li>
-<li>
- <span class="summary_signature">
- <a href="#message/2">message/2</a>
- </span>
-</li>
-<li>
- <span class="summary_signature">
- <a href="#new/0">new/0</a>
- </span>
-</li>
-<li>
- <span class="summary_signature">
- <a href="#new/1">new/1</a>
- </span>
-</li>
-<li>
- <span class="summary_signature">
- <a href="#to_keywords/1">to_keywords/1</a>
- </span>
-</li>
-<li>
- <span class="summary_signature">
- <a href="#update/2">update/2</a>
- </span>
-</li>
-<li>
- <span class="summary_signature">
- <a href="#update_message/2">update_message/2</a>
- </span>
-</li>
- </ul>
- <div id="functions_details" class="details_list">
- <h2>Functions</h2>
- <div class="detail">
- <p class="signature" id="exception/1">
- <strong>exception(args)</strong>
- </p>
- <div class="docstring"></div>
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/exception.ex#L156" target="_blank" class="view_source">Source</a>
-</div><div class="detail">
- <p class="signature" id="exception/2">
- <strong>exception(args, self)</strong>
- </p>
- <div class="docstring"></div>
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/exception.ex#L156" target="_blank" class="view_source">Source</a>
-</div><div class="detail">
- <p class="signature" id="message/1">
- <strong>message(record)</strong>
- </p>
- <div class="docstring"></div>
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/exception.ex#L156" target="_blank" class="view_source">Source</a>
-</div><div class="detail">
- <p class="signature" id="message/2">
- <strong>message(value, record)</strong>
- </p>
- <div class="docstring"></div>
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/exception.ex#L156" target="_blank" class="view_source">Source</a>
-</div><div class="detail">
- <p class="signature" id="new/0">
- <strong>new()</strong>
- </p>
- <div class="docstring"></div>
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/exception.ex#L156" target="_blank" class="view_source">Source</a>
-</div><div class="detail">
- <p class="signature" id="new/1">
- <strong>new(opts)</strong>
- </p>
- <div class="docstring"></div>
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/exception.ex#L156" target="_blank" class="view_source">Source</a>
-</div><div class="detail">
- <p class="signature" id="to_keywords/1">
- <strong>to_keywords(record)</strong>
- </p>
- <div class="docstring"></div>
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/exception.ex#L156" target="_blank" class="view_source">Source</a>
-</div><div class="detail">
- <p class="signature" id="update/2">
- <strong>update(keywords, record)</strong>
- </p>
- <div class="docstring"></div>
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/exception.ex#L156" target="_blank" class="view_source">Source</a>
-</div><div class="detail">
- <p class="signature" id="update_message/2">
- <strong>update_message(function, record)</strong>
- </p>
- <div class="docstring"></div>
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/exception.ex#L156" target="_blank" class="view_source">Source</a>
-</div>
- </div>
-
-
-
</div>
Oops, something went wrong.

0 comments on commit f55ddf5

Please sign in to comment.