Permalink
Browse files

Update docs

  • Loading branch information...
1 parent ba70514 commit 56587535bffb59278d0361925ebd67c2e6f5c7cd @josevalim josevalim committed Nov 18, 2012
Showing with 4,110 additions and 2,562 deletions.
  1. +2 −2 docs/master/Access.Atom.html
  2. +1 −1 docs/master/Access.Binary.Dict.html
  3. +2 −2 docs/master/Access.Function.html
  4. +1 −1 docs/master/Access.HashDict.html
  5. +2 −2 docs/master/Access.List.html
  6. +1 −1 docs/master/Access.Orddict.html
  7. +4 −5 docs/master/Access.html
  8. +15 −15 docs/master/Behaviour.html
  9. +18 −7 docs/master/Binary.Dict.html
  10. +1 −1 docs/master/Binary.Inspect.Any.html
  11. +1 −1 docs/master/Binary.Inspect.BitString.html
  12. +1 −1 docs/master/Binary.Inspect.List.html
  13. +1 −1 docs/master/Binary.Inspect.Number.html
  14. +1 −1 docs/master/Binary.Inspect.Regex.html
  15. +1 −1 docs/master/Binary.Inspect.Tuple.html
  16. +31 −32 docs/master/Code.html
  17. +33 −13 docs/master/Dict.html
  18. +1 −1 docs/master/Enum.Iterator.Binary.Dict.html
  19. +1 −1 docs/master/Enum.Iterator.Function.html
  20. +1 −1 docs/master/Enum.Iterator.HashDict.html
  21. +1 −1 docs/master/Enum.Iterator.List.html
  22. +1 −1 docs/master/Enum.Iterator.Orddict.html
  23. +31 −74 docs/master/Enum.html
  24. +12 −12 docs/master/ExUnit.Assertions.html
  25. +57 −62 docs/master/{Calendar.html → ExUnit.CLIFormatter.html}
  26. +57 −0 docs/master/ExUnit.Formatter.html
  27. +22 −4 docs/master/ExUnit.html
  28. +13 −13 docs/master/File.Stat.html
  29. +71 −58 docs/master/File.html
  30. +1 −1 docs/master/GenServer.Behaviour.html
  31. +1 −1 docs/master/IEx.Autocomplete.html
  32. +76 −11 docs/master/IEx.Helpers.html
  33. +53 −8 docs/master/IO.html
  34. +36 −5 docs/master/Kernel.SpecialForms.html
  35. +207 −32 docs/master/Kernel.Typespec.html
  36. +215 −189 docs/master/Kernel.html
  37. +2 −2 docs/master/{Keyword.KeyError.html → KeyError.html}
  38. +32 −20 docs/master/Keyword.html
  39. +14 −14 docs/master/List.html
  40. +43 −3 docs/master/Macro.Env.html
  41. +3 −3 docs/master/Macro.html
  42. +0 −12 docs/master/Mix.Deps.html
  43. +4 −6 docs/master/Mix.Project.html
  44. +3 −140 docs/master/Mix.SCM.html
  45. +103 −0 docs/master/Mix.Shell.IO.html
  46. +1 −62 docs/master/Mix.Shell.html
  47. +10 −10 docs/master/Mix.Task.html
  48. +9 −4 docs/master/Mix.Tasks.Compile.Elixir.html
  49. +1 −5 docs/master/Mix.Tasks.Compile.html
  50. +1 −1 docs/master/Mix.Tasks.Deps.Get.html
  51. +4 −2 docs/master/Mix.Tasks.Test.html
  52. +41 −29 docs/master/Mix.Utils.html
  53. +44 −41 docs/master/Module.html
  54. +43 −10 docs/master/Node.html
  55. +1 −1 docs/master/OptionParser.html
  56. +55 −28 docs/master/Process.html
  57. +38 −38 docs/master/Record.html
  58. +10 −10 docs/master/Regex.CompileError.html
  59. +13 −34 docs/master/Regex.html
  60. +96 −24 docs/master/String.html
  61. +39 −0 docs/master/System.html
  62. +0 −34 docs/master/URI.Parser.html
  63. +355 −242 docs/master/modules_list.html
  64. +1 −1 docs/master/protocols_list.html
  65. +44 −23 docs/master/records_list.html
  66. +2 −2 docs/stable/Access.Atom.html
  67. +1 −1 docs/stable/Access.Binary.Dict.html
  68. +2 −2 docs/stable/Access.Function.html
  69. +1 −1 docs/stable/Access.HashDict.html
  70. +2 −2 docs/stable/Access.List.html
  71. +1 −1 docs/stable/Access.OrdDict.html
  72. +4 −5 docs/stable/Access.html
  73. +15 −15 docs/stable/Behaviour.html
  74. +18 −7 docs/stable/Binary.Dict.html
  75. +1 −1 docs/stable/Binary.Inspect.Any.html
  76. +1 −1 docs/stable/Binary.Inspect.BitString.html
  77. +1 −1 docs/stable/Binary.Inspect.List.html
  78. +1 −1 docs/stable/Binary.Inspect.Number.html
  79. +1 −1 docs/stable/Binary.Inspect.Regex.html
  80. +1 −1 docs/stable/Binary.Inspect.Tuple.html
  81. +31 −32 docs/stable/Code.html
  82. +33 −13 docs/stable/Dict.html
  83. +1 −1 docs/stable/Enum.Iterator.Binary.Dict.html
  84. +1 −1 docs/stable/Enum.Iterator.Function.html
  85. +1 −1 docs/stable/Enum.Iterator.HashDict.html
  86. +1 −1 docs/stable/Enum.Iterator.List.html
  87. +1 −1 docs/stable/Enum.Iterator.Orddict.html
  88. +31 −74 docs/stable/Enum.html
  89. +12 −12 docs/stable/ExUnit.Assertions.html
  90. +197 −0 docs/stable/ExUnit.CLIFormatter.html
  91. +57 −0 docs/stable/ExUnit.Formatter.html
  92. +22 −4 docs/stable/ExUnit.html
  93. +13 −13 docs/stable/File.Stat.html
  94. +71 −58 docs/stable/File.html
  95. +1 −1 docs/stable/GenServer.Behaviour.html
  96. +1 −1 docs/stable/IEx.Autocomplete.html
  97. +76 −11 docs/stable/IEx.Helpers.html
  98. +53 −8 docs/stable/IO.html
  99. +36 −5 docs/stable/Kernel.SpecialForms.html
  100. +207 −32 docs/stable/Kernel.Typespec.html
  101. +215 −189 docs/stable/Kernel.html
  102. +2 −2 docs/stable/{Keyword.KeyError.html → KeyError.html}
  103. +32 −20 docs/stable/Keyword.html
  104. +14 −14 docs/stable/List.html
  105. +43 −3 docs/stable/Macro.Env.html
  106. +3 −3 docs/stable/Macro.html
  107. +0 −12 docs/stable/Mix.Deps.html
  108. +4 −6 docs/stable/Mix.Project.html
  109. +3 −140 docs/stable/Mix.SCM.html
  110. +103 −0 docs/stable/Mix.Shell.IO.html
  111. +1 −62 docs/stable/Mix.Shell.html
  112. +10 −10 docs/stable/Mix.Task.html
  113. +9 −4 docs/stable/Mix.Tasks.Compile.Elixir.html
  114. +1 −5 docs/stable/Mix.Tasks.Compile.html
  115. +1 −1 docs/stable/Mix.Tasks.Deps.Get.html
  116. +4 −2 docs/stable/Mix.Tasks.Test.html
  117. +45 −33 docs/stable/Mix.Utils.html
  118. +44 −41 docs/stable/Module.html
  119. +43 −10 docs/stable/Node.html
  120. +1 −1 docs/stable/OptionParser.html
  121. +55 −28 docs/stable/Process.html
  122. +38 −38 docs/stable/Record.html
  123. +10 −10 docs/stable/Regex.CompileError.html
  124. +13 −34 docs/stable/Regex.html
  125. +96 −24 docs/stable/String.html
  126. +39 −0 docs/stable/System.html
  127. +0 −34 docs/stable/URI.Parser.html
  128. +355 −140 docs/stable/modules_list.html
  129. +1 −1 docs/stable/protocols_list.html
  130. +44 −23 docs/stable/records_list.html
@@ -29,7 +29,7 @@
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/access.ex#L40" target="_blank" class="view_source">Source</a>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/access.ex#L39" target="_blank" class="view_source">Source</a>
@@ -62,7 +62,7 @@
at compilation time. If we reach this, we should raise
an exception.</p>
</div>
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/access.ex#L46" target="_blank" class="view_source">Source</a>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/access.ex#L45" target="_blank" class="view_source">Source</a>
</div>
</div>
@@ -29,7 +29,7 @@
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/binary/dict.ex#L79" target="_blank" class="view_source">Source</a>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/binary/dict.ex#L86" target="_blank" class="view_source">Source</a>
@@ -29,7 +29,7 @@
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/access.ex#L55" target="_blank" class="view_source">Source</a>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/access.ex#L54" target="_blank" class="view_source">Source</a>
@@ -63,7 +63,7 @@
is useful because it allows a function to be
passed as argument in places a dict would also fit.</p>
</div>
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/access.ex#L62" target="_blank" class="view_source">Source</a>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/access.ex#L61" target="_blank" class="view_source">Source</a>
</div>
</div>
@@ -29,7 +29,7 @@
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/hash_dict.ex#L95" target="_blank" class="view_source">Source</a>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/hash_dict.ex#L103" target="_blank" class="view_source">Source</a>
@@ -29,7 +29,7 @@
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/access.ex#L23" target="_blank" class="view_source">Source</a>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/access.ex#L22" target="_blank" class="view_source">Source</a>
@@ -66,7 +66,7 @@
keywords[:a] #=&gt; 1
</code></pre>
</div>
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/access.ex#L34" target="_blank" class="view_source">Source</a>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/access.ex#L33" target="_blank" class="view_source">Source</a>
</div>
</div>
@@ -29,7 +29,7 @@
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/ord_dict.ex#L93" target="_blank" class="view_source">Source</a>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/ord_dict.ex#L101" target="_blank" class="view_source">Source</a>
View
@@ -32,11 +32,10 @@
<p>The Access protocol is the underlying protocol invoked
when the brackets syntax is used. For instance, <code>foo[bar]</code>
is translated to <code>access foo, bar</code> which, by default,
-invokes <code>Access.access</code> protocol.</p>
+invokes the <code>Access.access</code> protocol.</p>
<p>This protocol is limited and is implemented only for the
-following built-in types: keywords, records, atoms and
-functions.</p>
+following built-in types: keywords, records and functions.</p>
</div>
@@ -109,11 +108,11 @@
<h2>Functions</h2>
<div class="detail">
<p class="signature" id="access/2">
- <strong>access(element, qualifier)</strong>
+ <strong>access(container, key)</strong>
</p>
<div class="docstring"><p>Receives the element being accessed and the access item.</p>
</div>
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/access.ex#L20" target="_blank" class="view_source">Source</a>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/access.ex#L19" target="_blank" class="view_source">Source</a>
</div>
</div>
View
@@ -39,14 +39,14 @@
use Behaviour
@doc &quot;Parses the given URL&quot;
- defcallback parse(arg)
+ defcallback parse(uri_info :: URI.Info.t), do: URI.Info.t
@doc &quot;Defines a default port&quot;
- defcallback default_port()
+ defcallback default_port(), do: integer
end
</code></pre>
-<p>And then a specific protocol may use it as:</p>
+<p>And then a specific module may use it as:</p>
<pre><code>defmodule URI.HTTP do
@behaviour URI.Parser
@@ -61,11 +61,14 @@
<h2>Implementation</h2>
-<p>Internally, Erlang call <code>behaviour_info(:callbacks)</code>
-to obtain all functions that a behaviour should
-implemented. Therefore, all this module does is
-to define <code>behaviour_info(:callbacks)</code> with the
-<code>defcallback</code> definitions.</p>
+<p>Behaviours since Erlang R15 must be defined via
+<code>@callback</code> attributes. <code>defcallback</code> is a simple
+mechanism that defines the <code>@callback</code> attribute
+according to the type specification and also allows
+docs and defines a custom function signature.</p>
+
+<p>The callbacks and their documentation can be retrieved
+via the <code>__behaviour__</code> callback function.</p>
</div>
@@ -83,7 +86,7 @@
<ul class="summary">
<li>
<span class="summary_signature">
- <a href="#defcallback/1">defcallback/1</a>
+ <a href="#defcallback/2">defcallback/2</a>
</span>
</li>
@@ -98,13 +101,10 @@
<div id="macros_details" class="details_list">
<h2>Macros</h2>
<div class="detail">
- <p class="signature" id="defcallback/1">
- <strong>defcallback(fun)</strong>
+ <p class="signature" id="defcallback/2">
+ <strong>defcallback(fun, list2)</strong>
</p>
- <div class="docstring"><p>Annotates the given function is a callback. <code>defcallback</code> is
-slightly different than simple using <code>def</code> because, even if
-<code>defcallback</code> contains default values, a default function
-won&#39;t be generated, which would happen with <code>def</code>.</p>
+ <div class="docstring"><p>Defines a callback according to the given type specification.</p>
</div>
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/behaviour.ex#L48" target="_blank" class="view_source">Source</a>
</div>
@@ -62,6 +62,11 @@
</li>
<li>
<span class="summary_signature">
+ <a href="#get!/2">get!/2</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
<a href="#has_key?/2">has_key?/2</a>
</span>
</li>
@@ -136,20 +141,26 @@
<strong>delete(arg1, key)</strong>
</p>
<div class="docstring"></div>
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/binary/dict.ex#L45" target="_blank" class="view_source">Source</a>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/binary/dict.ex#L52" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="empty/1">
<strong>empty(_)</strong>
</p>
<div class="docstring"></div>
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/binary/dict.ex#L65" target="_blank" class="view_source">Source</a>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/binary/dict.ex#L72" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="get/3">
<strong>get(arg1, key, default)</strong>
</p>
<div class="docstring"></div>
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/binary/dict.ex#L34" target="_blank" class="view_source">Source</a>
</div><div class="detail">
+ <p class="signature" id="get!/2">
+ <strong>get!(arg1, key)</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/binary/dict.ex#L41" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
<p class="signature" id="has_key?/2">
<strong>has_key?(arg1, key)</strong>
</p>
@@ -166,7 +177,7 @@
<strong>merge(d1, d2, fun)</strong>
</p>
<div class="docstring"></div>
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/binary/dict.ex#L49" target="_blank" class="view_source">Source</a>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/binary/dict.ex#L56" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="new/0">
<strong>new()</strong>
@@ -206,7 +217,7 @@
<strong>put(arg1, key, value)</strong>
</p>
<div class="docstring"></div>
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/binary/dict.ex#L41" target="_blank" class="view_source">Source</a>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/binary/dict.ex#L48" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="size/1">
<strong>size(arg1)</strong>
@@ -218,19 +229,19 @@
<strong>to_list(arg1)</strong>
</p>
<div class="docstring"></div>
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/binary/dict.ex#L69" target="_blank" class="view_source">Source</a>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/binary/dict.ex#L76" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="update/3">
<strong>update(arg1, key, fun)</strong>
</p>
<div class="docstring"></div>
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/binary/dict.ex#L57" target="_blank" class="view_source">Source</a>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/binary/dict.ex#L64" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="update/4">
<strong>update(arg1, key, initial, fun)</strong>
</p>
<div class="docstring"></div>
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/binary/dict.ex#L61" target="_blank" class="view_source">Source</a>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/binary/dict.ex#L68" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="values/1">
<strong>values(arg1)</strong>
@@ -40,7 +40,7 @@
</div>
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/binary/inspect.ex#L430" target="_blank" class="view_source">Source</a>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/binary/inspect.ex#L418" target="_blank" class="view_source">Source</a>
@@ -41,7 +41,7 @@
</div>
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/binary/inspect.ex#L182" target="_blank" class="view_source">Source</a>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/binary/inspect.ex#L178" target="_blank" class="view_source">Source</a>
@@ -49,7 +49,7 @@
</div>
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/binary/inspect.ex#L240" target="_blank" class="view_source">Source</a>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/binary/inspect.ex#L236" target="_blank" class="view_source">Source</a>
@@ -39,7 +39,7 @@
</div>
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/binary/inspect.ex#L396" target="_blank" class="view_source">Source</a>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/binary/inspect.ex#L380" target="_blank" class="view_source">Source</a>
@@ -39,7 +39,7 @@
</div>
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/binary/inspect.ex#L415" target="_blank" class="view_source">Source</a>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/binary/inspect.ex#L399" target="_blank" class="view_source">Source</a>
@@ -41,7 +41,7 @@
</div>
- <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/binary/inspect.ex#L309" target="_blank" class="view_source">Source</a>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/binary/inspect.ex#L298" target="_blank" class="view_source">Source</a>
Oops, something went wrong.

0 comments on commit 5658753

Please sign in to comment.