Skip to content

Commit

Permalink
Updated docs for 0.6.0 release.
Browse files Browse the repository at this point in the history
  • Loading branch information
@oubiwann
oubiwann committed Jul 19, 2018
1 parent 4f7f283 commit d248e22
Show file tree
Hide file tree
Showing 24 changed files with 25 additions and 25 deletions.
2 changes: 1 addition & 1 deletion docs/current/20-mid-level-api.html
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!DOCTYPE html PUBLIC ""
"">
<html><head><meta charset="UTF-8" /><title>Clojang User's Guide</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="highlight/atom-one-dark.css" /><script type="text/javascript" src="highlight/highlight.pack.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a> with the <a href="https://github.com/clojang/codox-theme">Clojang UI</a> theme</h2><h1><a href="index.html"><span class="project-title"><span class="project-name">clojang</span> <span class="project-version">0.4.0</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Topics</span></h3><ul><li class="depth-1 current"><a href="20-mid-level-api.html"><div class="inner"><span>Clojang User's Guide</span></div></a></li><li class="depth-1 "><a href="30-talking-to-servers.html"><div class="inner"><span>Talking to Servers: LFE &amp; Clojure</span></div></a></li><li class="depth-1 "><a href="31-talking-to-servers-erlang.html"><div class="inner"><span>Talking to Servers: Erlang &amp; Clojure</span></div></a></li><li class="depth-1 "><a href="32-talking-to-servers-elixir.html"><div class="inner"><span>Talking to Servers: Elixir &amp; Clojure</span></div></a></li><li class="depth-1 "><a href="40-creating-apps.html"><div class="inner"><span>Apps Tutorial</span></div></a></li><li class="depth-1 "><a href="98-other-resources.html"><div class="inner"><span>Other Resources</span></div></a></li><li class="depth-1 "><a href="99-other-versions.html"><div class="inner"><span>API Docs (All Versions)</span></div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>clojang</span></div></div></li><li class="depth-2 branch"><a href="clojang.caller.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>caller</span></div></a></li><li class="depth-2 branch"><a href="clojang.conn.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>conn</span></div></a></li><li class="depth-2 branch"><a href="clojang.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-2 branch"><a href="clojang.epmd.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>epmd</span></div></a></li><li class="depth-2 branch"><a href="clojang.exceptions.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>exceptions</span></div></a></li><li class="depth-2 branch"><a href="clojang.mbox.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>mbox</span></div></a></li><li class="depth-2 branch"><a href="clojang.msg.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>msg</span></div></a></li><li class="depth-2 branch"><a href="clojang.node.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>node</span></div></a></li><li class="depth-2 branch"><a href="clojang.rpc.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>rpc</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>types</span></div></div></li><li class="depth-3 branch"><a href="clojang.types.constructor.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>constructor</span></div></a></li><li class="depth-3 branch"><a href="clojang.types.converter.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>converter</span></div></a></li><li class="depth-3 branch"><a href="clojang.types.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-3 branch"><a href="clojang.types.predicate.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>predicate</span></div></a></li><li class="depth-3"><a href="clojang.types.records.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>records</span></div></a></li><li class="depth-2"><a href="clojang.util.html"><div class="inner"><span class="tree" style="top: -176px;"><span class="top" style="height: 185px;"></span><span class="bottom"></span></span><span>util</span></div></a></li></ul></div><div class="document" id="content"><div class="doc"><div class="markdown"><h1><a href="#clojang-users-guide" name="clojang-users-guide"></a>Clojang User’s Guide</h1>
<html><head><meta charset="UTF-8" /><title>Clojang User's Guide</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="highlight/atom-one-dark.css" /><script type="text/javascript" src="highlight/highlight.pack.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a> with the <a href="https://github.com/clojang/codox-theme">Clojang UI</a> theme</h2><h1><a href="index.html"><span class="project-title"><span class="project-name">clojang</span> <span class="project-version">0.6.0</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Topics</span></h3><ul><li class="depth-1 current"><a href="20-mid-level-api.html"><div class="inner"><span>Clojang User's Guide</span></div></a></li><li class="depth-1 "><a href="30-talking-to-servers.html"><div class="inner"><span>Talking to Servers: LFE &amp; Clojure</span></div></a></li><li class="depth-1 "><a href="31-talking-to-servers-erlang.html"><div class="inner"><span>Talking to Servers: Erlang &amp; Clojure</span></div></a></li><li class="depth-1 "><a href="32-talking-to-servers-elixir.html"><div class="inner"><span>Talking to Servers: Elixir &amp; Clojure</span></div></a></li><li class="depth-1 "><a href="40-creating-apps.html"><div class="inner"><span>Apps Tutorial</span></div></a></li><li class="depth-1 "><a href="98-other-resources.html"><div class="inner"><span>Other Resources</span></div></a></li><li class="depth-1 "><a href="99-other-versions.html"><div class="inner"><span>API Docs (All Versions)</span></div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>clojang</span></div></div></li><li class="depth-2 branch"><a href="clojang.caller.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>caller</span></div></a></li><li class="depth-2 branch"><a href="clojang.conn.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>conn</span></div></a></li><li class="depth-2 branch"><a href="clojang.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-2 branch"><a href="clojang.epmd.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>epmd</span></div></a></li><li class="depth-2 branch"><a href="clojang.exceptions.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>exceptions</span></div></a></li><li class="depth-2 branch"><a href="clojang.mbox.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>mbox</span></div></a></li><li class="depth-2 branch"><a href="clojang.msg.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>msg</span></div></a></li><li class="depth-2 branch"><a href="clojang.node.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>node</span></div></a></li><li class="depth-2 branch"><a href="clojang.rpc.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>rpc</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>types</span></div></div></li><li class="depth-3 branch"><a href="clojang.types.constructor.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>constructor</span></div></a></li><li class="depth-3 branch"><a href="clojang.types.converter.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>converter</span></div></a></li><li class="depth-3 branch"><a href="clojang.types.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-3 branch"><a href="clojang.types.predicate.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>predicate</span></div></a></li><li class="depth-3"><a href="clojang.types.records.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>records</span></div></a></li><li class="depth-2"><a href="clojang.util.html"><div class="inner"><span class="tree" style="top: -176px;"><span class="top" style="height: 185px;"></span><span class="bottom"></span></span><span>util</span></div></a></li></ul></div><div class="document" id="content"><div class="doc"><div class="markdown"><h1><a href="#clojang-users-guide" name="clojang-users-guide"></a>Clojang User’s Guide</h1>
<p><strong>NOTICE</strong>: This document is an adaptatoin of the <em>jiface User’s Guide</em>, (which, in turn was copied from the <a href="erlang/jinterface_users_guide.html">JInterface User’s Guide</a>); the adaptations include significant changes, due to a much more simplified API (or, perhaps more accurately, a more varied API but with sane defaults provided). Unlike the low-level guide upon which it is based, this one provides information for developers interested in using the Clojang API which is designed to save time and effort without the need of manually translating between Clojure and JInterface’s Erlang data types.</p>
<p>In the following examples, we assume that you have <code>require</code>ed the necessary namespaces and <code>import</code>ed the Java classes needed in a Clojang REPL:</p>
<pre><code class="clj">=&gt; (require '[clojang.conn :as conn]
Expand Down
Loading

0 comments on commit d248e22

Please sign in to comment.