Add docs!

kf0jvt · Mar 6, 2015 · 7b9a449 · 7b9a449
1 parent f140617
commit 7b9a449
Show file tree

Hide file tree

Showing 27 changed files with 3,169 additions and 12 deletions.
diff --git a/doc/KafkaEx.Connection.html b/doc/KafkaEx.Connection.html
@@ -0,0 +1,185 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>KafkaEx.Connection</title>
+    <meta charset="utf-8" />
+    <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
+    <link rel="stylesheet" href="css/elixir.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>
+    <script type="text/javascript" charset="utf-8" src="js/highlight.pack.js"></script>
+    <script type="text/javascript" charset="utf-8">
+      hljs.initHighlightingOnLoad();
+      hljs.configure({languages: []}); //disable autodetect
+    </script>
+  </head>
+
+  <body>
+    <script type="text/javascript" charset="utf-8">
+      if (window.top.frames.main) document.body.className = 'frames';
+    </script>
+
+    <section id="content">
+      <div class="breadcrumbs">kafka_ex v0.0.1 &rarr; <a href="overview.html">Overview</a> &rarr; <a href="KafkaEx.html">KafkaEx</a> &rarr; <a href="KafkaEx.Connection.html">Connection</a></div>
+      <h1>
+        KafkaEx.Connection
+
+      </h1>
+
+      <ul class="summary_links">
+
+          <li><a href="#summary">Summary</a></li>
+
+
+
+          <li><a href="#functions_details">Functions</a></li>
+
+
+
+      </ul>
+
+
+
+
+
+
+        <h2 id="summary">Summary<span class="detail_header_links"><a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a></span></h2>
+        <table class="summary">
+          <tr>
+  <td class="summary_signature"><a href="#close/1">close(socket)</a></td>
+
+</tr>
+<tr>
+  <td class="summary_signature"><a href="#connect/2">connect(host, port)</a></td>
+
+</tr>
+<tr>
+  <td class="summary_signature"><a href="#connect_brokers/2">connect_brokers(uris, socket_map \\ %{})</a></td>
+
+</tr>
+<tr>
+  <td class="summary_signature"><a href="#format_host/1">format_host(host)</a></td>
+
+</tr>
+<tr>
+  <td class="summary_signature"><a href="#format_uri/2">format_uri(host, port)</a></td>
+
+</tr>
+<tr>
+  <td class="summary_signature"><a href="#send/2">send(message, socket)</a></td>
+
+</tr>
+
+        </table>
+
+
+
+
+
+        <section id="functions_details" class="details_list">
+          <h2>Functions</h2>
+          <section class="detail">
+  <div class="detail_header" id="close/1">
+    <span class="signature"><strong>close(socket)</strong></span>
+    <div class="detail_header_links">
+      <span class="detail_type">(function)</span>
+      <a href="#close/1" class="detail_link" title="Link to this function">#</a>
+      <a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
+    </div>
+  </div>
+
+  <section class="docstring">
+
+  </section>
+
+</section>
+<section class="detail">
+  <div class="detail_header" id="connect/2">
+    <span class="signature"><strong>connect(host, port)</strong></span>
+    <div class="detail_header_links">
+      <span class="detail_type">(function)</span>
+      <a href="#connect/2" class="detail_link" title="Link to this function">#</a>
+      <a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
+    </div>
+  </div>
+
+  <section class="docstring">
+
+  </section>
+
+</section>
+<section class="detail">
+  <div class="detail_header" id="connect_brokers/2">
+    <span class="signature"><strong>connect_brokers(uris, socket_map \\ %{})</strong></span>
+    <div class="detail_header_links">
+      <span class="detail_type">(function)</span>
+      <a href="#connect_brokers/2" class="detail_link" title="Link to this function">#</a>
+      <a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
+    </div>
+  </div>
+
+  <section class="docstring">
+
+  </section>
+
+</section>
+<section class="detail">
+  <div class="detail_header" id="format_host/1">
+    <span class="signature"><strong>format_host(host)</strong></span>
+    <div class="detail_header_links">
+      <span class="detail_type">(function)</span>
+      <a href="#format_host/1" class="detail_link" title="Link to this function">#</a>
+      <a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
+    </div>
+  </div>
+
+  <section class="docstring">
+
+  </section>
+
+</section>
+<section class="detail">
+  <div class="detail_header" id="format_uri/2">
+    <span class="signature"><strong>format_uri(host, port)</strong></span>
+    <div class="detail_header_links">
+      <span class="detail_type">(function)</span>
+      <a href="#format_uri/2" class="detail_link" title="Link to this function">#</a>
+      <a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
+    </div>
+  </div>
+
+  <section class="docstring">
+
+  </section>
+
+</section>
+<section class="detail">
+  <div class="detail_header" id="send/2">
+    <span class="signature"><strong>send(message, socket)</strong></span>
+    <div class="detail_header_links">
+      <span class="detail_type">(function)</span>
+      <a href="#send/2" class="detail_link" title="Link to this function">#</a>
+      <a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
+    </div>
+  </div>
+
+  <section class="docstring">
+
+  </section>
+
+</section>
+
+        </section>
+
+
+
+
+
+    </section>
+  </body>
+</html>
diff --git a/doc/KafkaEx.ConnectionError.html b/doc/KafkaEx.ConnectionError.html
@@ -0,0 +1,133 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>KafkaEx.ConnectionError</title>
+    <meta charset="utf-8" />
+    <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
+    <link rel="stylesheet" href="css/elixir.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>
+    <script type="text/javascript" charset="utf-8" src="js/highlight.pack.js"></script>
+    <script type="text/javascript" charset="utf-8">
+      hljs.initHighlightingOnLoad();
+      hljs.configure({languages: []}); //disable autodetect
+    </script>
+  </head>
+
+  <body>
+    <script type="text/javascript" charset="utf-8">
+      if (window.top.frames.main) document.body.className = 'frames';
+    </script>
+
+    <section id="content">
+      <div class="breadcrumbs">kafka_ex v0.0.1 &rarr; <a href="overview.html">Overview</a> &rarr; <a href="KafkaEx.html">KafkaEx</a> &rarr; <a href="KafkaEx.ConnectionError.html">ConnectionError</a></div>
+      <h1>
+        KafkaEx.ConnectionError
+
+          <small>exception</small>
+
+      </h1>
+
+      <ul class="summary_links">
+
+          <li><a href="#summary">Summary</a></li>
+
+
+
+          <li><a href="#functions_details">Functions</a></li>
+
+
+
+      </ul>
+
+
+
+
+
+
+        <h2 id="summary">Summary<span class="detail_header_links"><a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a></span></h2>
+        <table class="summary">
+          <tr>
+  <td class="summary_signature"><a href="#exception/1">exception(args)</a></td>
+
+    <td class="summary_synopsis"><p>Callback implementation of <code class="inline">Exception.exception/1</code></p>
+</td>
+
+</tr>
+<tr>
+  <td class="summary_signature"><a href="#message/1">message(exception)</a></td>
+
+    <td class="summary_synopsis"><p>Callback implementation of <code class="inline">Exception.message/1</code></p>
+</td>
+
+</tr>
+
+        </table>
+
+
+
+
+
+        <section id="functions_details" class="details_list">
+          <h2>Functions</h2>
+          <section class="detail">
+  <div class="detail_header" id="exception/1">
+    <span class="signature"><strong>exception(args)</strong></span>
+    <div class="detail_header_links">
+      <span class="detail_type">(function)</span>
+      <a href="#exception/1" class="detail_link" title="Link to this function">#</a>
+      <a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
+    </div>
+  </div>
+
+    <p>Specs:</p>
+    <ul class="spec">
+
+        <li>exception(<a href="http://elixir-lang.org/docs/stable/elixir/Keyword.html#t:t/0">Keyword.t</a>) :: <a href="http://elixir-lang.org/docs/stable/elixir/Exception.html#t:t/0">Exception.t</a></li>
+
+    </ul>
+
+  <section class="docstring">
+    <p>Callback implementation of <code class="inline">Exception.exception/1</code>.</p>
+
+  </section>
+
+</section>
+<section class="detail">
+  <div class="detail_header" id="message/1">
+    <span class="signature"><strong>message(exception)</strong></span>
+    <div class="detail_header_links">
+      <span class="detail_type">(function)</span>
+      <a href="#message/1" class="detail_link" title="Link to this function">#</a>
+      <a class="to_top_link" href="#content" title="To the top of the page">&uarr;</a>
+    </div>
+  </div>
+
+    <p>Specs:</p>
+    <ul class="spec">
+
+        <li>message(<a href="http://elixir-lang.org/docs/stable/elixir/Exception.html#t:t/0">Exception.t</a>) :: <a href="http://elixir-lang.org/docs/stable/elixir/String.html#t:t/0">String.t</a></li>
+
+    </ul>
+
+  <section class="docstring">
+    <p>Callback implementation of <code class="inline">Exception.message/1</code>.</p>
+
+  </section>
+
+</section>
+
+        </section>
+
+
+
+
+
+    </section>
+  </body>
+</html>