Browse files

Autodoc commit for master/f5d33f46

  • Loading branch information...
1 parent 2bfee16 commit 7f6b08f7add01aeeb86b4d9594b91432aaf4b2d1 Tom Faulhaber committed Jun 6, 2016
Showing with 28 additions and 17 deletions.
  1. +6 −6 api-index.html
  2. +10 −11 index-0.1.1.clj
  3. +12 −0 index.html
View
12 api-index.html
@@ -43,19 +43,19 @@
<div id="right-sidebar"></div>
<div id="content-tag"><h1 id="overview">Index of Public Functions and Variables - <span id="header-project">Native codec implementations</span> <span id="header-version">0.1.1</span><span id="header-status-block"> (<span id="header-status">in development</span>)</span></h1>
This page has an alphabetical index of all the documented functions and variables
-in <span class="project-name-span">Native codec implementations</span>.
+in <span class="project-name-span">Native codec implementations</span>.
<!-- TODO: enable this functionality on github?
-In a narrow browser window, you may want to collapse the sidebar (use the \"<<\" link)
-to get more screen space for the index.
+In a narrow browser window, you may want to collapse the sidebar (use the \"<<\" link)
+to get more screen space for the index.
-->
-
-<div class="shortcuts">
+<p>
+</p><div class="shortcuts">
Shortcuts:<br />
<a href="#A">A</a> <a href="#B">B</a> <a href="#C">C</a> <a href="#D">D</a>
<a href="#E">E</a> <a href="#F">F</a> <a href="#G">G</a> <a href="#H">H</a>
- <a href="#I">I</a> <a href="#J">J</a> <a href="#K">K</a> <a href="#L">L</a>
+ <a href="#I">I</a> <a href="#J">J</a> <a href="#K">K</a> <a href="#L">L</a>
<a href="#M">M</a>
<br />
<a href="#N">N</a> <a href="#O">O</a> <a href="#P">P</a> <a href="#Q">Q</a>
View
21 index-0.1.1.clj
@@ -2,8 +2,7 @@
({:doc "Functions for working with base64 encodings.",
:author "Alex Taggart",
:name "clojure.data.codec.base64",
- :wiki-url
- "http://clojure.github.com/data.codec/clojure.data.codec.base64-api.html",
+ :wiki-url "http://clojure.github.io/data.codec/index.html",
:source-url
"https://github.com/clojure/data.codec/blob/766746c11459a70cab27f7e0668a0be1f35fd679/src/main/clojure/clojure/data/codec/base64.clj"}),
:vars
@@ -20,7 +19,7 @@
"Calculates what would be the length after decoding of an input array of length\nin-length with the specified padding length.",
:namespace "clojure.data.codec.base64",
:wiki-url
- "http://clojure.github.com/data.codec//clojure.data.codec.base64-api.html#clojure.data.codec.base64/dec-length"}
+ "http://clojure.github.io/data.codec//index.html#clojure.data.codec.base64/dec-length"}
{:raw-source-url
"https://github.com/clojure/data.codec/raw/766746c11459a70cab27f7e0668a0be1f35fd679/src/main/clojure/clojure/data/codec/base64.clj",
:name "decode",
@@ -34,7 +33,7 @@
"Returns a base64 decoded byte array.\n\nNote: length must be a multiple of 4.",
:namespace "clojure.data.codec.base64",
:wiki-url
- "http://clojure.github.com/data.codec//clojure.data.codec.base64-api.html#clojure.data.codec.base64/decode"}
+ "http://clojure.github.io/data.codec//index.html#clojure.data.codec.base64/decode"}
{:raw-source-url
"https://github.com/clojure/data.codec/raw/766746c11459a70cab27f7e0668a0be1f35fd679/src/main/clojure/clojure/data/codec/base64.clj",
:name "decode!",
@@ -48,7 +47,7 @@
"Reads from the input byte array for the specified length starting at the offset\nindex, and base64 decodes into the output array starting at index 0. Returns the\nlength written to output.\n\nNote: length must be a multiple of 4.",
:namespace "clojure.data.codec.base64",
:wiki-url
- "http://clojure.github.com/data.codec//clojure.data.codec.base64-api.html#clojure.data.codec.base64/decode!"}
+ "http://clojure.github.io/data.codec//index.html#clojure.data.codec.base64/decode!"}
{:raw-source-url
"https://github.com/clojure/data.codec/raw/766746c11459a70cab27f7e0668a0be1f35fd679/src/main/clojure/clojure/data/codec/base64.clj",
:name "decoding-transfer",
@@ -62,7 +61,7 @@
"Base64 decodes from input-stream to output-stream. Returns nil or throws IOException.\n\nOptions are key/value pairs and may be one of\n :buffer-size read buffer size to use, must be a multiple of 4; default is 8192.",
:namespace "clojure.data.codec.base64",
:wiki-url
- "http://clojure.github.com/data.codec//clojure.data.codec.base64-api.html#clojure.data.codec.base64/decoding-transfer"}
+ "http://clojure.github.io/data.codec//index.html#clojure.data.codec.base64/decoding-transfer"}
{:raw-source-url
"https://github.com/clojure/data.codec/raw/766746c11459a70cab27f7e0668a0be1f35fd679/src/main/clojure/clojure/data/codec/base64.clj",
:name "enc-length",
@@ -76,7 +75,7 @@
"Calculates what would be the length after encoding of an input array of length n.",
:namespace "clojure.data.codec.base64",
:wiki-url
- "http://clojure.github.com/data.codec//clojure.data.codec.base64-api.html#clojure.data.codec.base64/enc-length"}
+ "http://clojure.github.io/data.codec//index.html#clojure.data.codec.base64/enc-length"}
{:raw-source-url
"https://github.com/clojure/data.codec/raw/766746c11459a70cab27f7e0668a0be1f35fd679/src/main/clojure/clojure/data/codec/base64.clj",
:name "encode",
@@ -89,7 +88,7 @@
:doc "Returns a base64 encoded byte array.",
:namespace "clojure.data.codec.base64",
:wiki-url
- "http://clojure.github.com/data.codec//clojure.data.codec.base64-api.html#clojure.data.codec.base64/encode"}
+ "http://clojure.github.io/data.codec//index.html#clojure.data.codec.base64/encode"}
{:raw-source-url
"https://github.com/clojure/data.codec/raw/766746c11459a70cab27f7e0668a0be1f35fd679/src/main/clojure/clojure/data/codec/base64.clj",
:name "encode!",
@@ -103,7 +102,7 @@
"Reads from the input byte array for the specified length starting at the offset\nindex, and base64 encodes into the output array starting at index 0. Returns the\nlength written to output.\n\nNote: if using partial input, length must be a multiple of 3 to avoid padding.",
:namespace "clojure.data.codec.base64",
:wiki-url
- "http://clojure.github.com/data.codec//clojure.data.codec.base64-api.html#clojure.data.codec.base64/encode!"}
+ "http://clojure.github.io/data.codec//index.html#clojure.data.codec.base64/encode!"}
{:raw-source-url
"https://github.com/clojure/data.codec/raw/766746c11459a70cab27f7e0668a0be1f35fd679/src/main/clojure/clojure/data/codec/base64.clj",
:name "encoding-transfer",
@@ -117,7 +116,7 @@
"Base64 encodes from input-stream to output-stream. Returns nil or throws IOException.\n\nOptions are key/value pairs and may be one of\n :buffer-size read buffer size to use, must be a multiple of 3; default is 6144.",
:namespace "clojure.data.codec.base64",
:wiki-url
- "http://clojure.github.com/data.codec//clojure.data.codec.base64-api.html#clojure.data.codec.base64/encoding-transfer"}
+ "http://clojure.github.io/data.codec//index.html#clojure.data.codec.base64/encoding-transfer"}
{:raw-source-url
"https://github.com/clojure/data.codec/raw/766746c11459a70cab27f7e0668a0be1f35fd679/src/main/clojure/clojure/data/codec/base64.clj",
:name "pad-length",
@@ -130,4 +129,4 @@
:doc "Returns the length of padding on the end of the input array.",
:namespace "clojure.data.codec.base64",
:wiki-url
- "http://clojure.github.com/data.codec//clojure.data.codec.base64-api.html#clojure.data.codec.base64/pad-length"})}
+ "http://clojure.github.io/data.codec//index.html#clojure.data.codec.base64/pad-length"})}
View
12 index.html
@@ -81,6 +81,9 @@ <h1 class="nopad">Table of Contents</h1>
<a href="#clojure.data.codec.base64/pad-length" class="toc-entry-anchor">pad-length</a>
</div>
+ </div><div class="toc-section" style="margin-left: 1em;">
+ <a style="margin-top: 3px;" href="#"></a>
+
</div>
</div>
</div>
@@ -111,6 +114,7 @@ <h2 id="clojure.data.codec.base64/dec-length">dec-length</h2>
</pre>
<pre id="var-docstr">Calculates what would be the length after decoding of an input array of length
in-length with the specified padding length.</pre>
+ <pre id="var-specs"></pre>
<a id="var-source" href="https://github.com/clojure/data.codec/blob/766746c11459a70cab27f7e0668a0be1f35fd679/src/main/clojure/clojure/data/codec/base64.clj#L39">Source</a>
@@ -125,6 +129,7 @@ <h2 id="clojure.data.codec.base64/decode">decode</h2>
<pre id="var-docstr">Returns a base64 decoded byte array.
Note: length must be a multiple of 4.</pre>
+ <pre id="var-specs"></pre>
<a id="var-source" href="https://github.com/clojure/data.codec/blob/766746c11459a70cab27f7e0668a0be1f35fd679/src/main/clojure/clojure/data/codec/base64.clj#L139">Source</a>
@@ -140,6 +145,7 @@ <h2 id="clojure.data.codec.base64/decode!">decode!</h2>
length written to output.
Note: length must be a multiple of 4.</pre>
+ <pre id="var-specs"></pre>
<a id="var-source" href="https://github.com/clojure/data.codec/blob/766746c11459a70cab27f7e0668a0be1f35fd679/src/main/clojure/clojure/data/codec/base64.clj#L59">Source</a>
@@ -154,6 +160,7 @@ <h2 id="clojure.data.codec.base64/decoding-transfer">decoding-transfer</h2>
Options are key/value pairs and may be one of
:buffer-size read buffer size to use, must be a multiple of 4; default is 8192.</pre>
+ <pre id="var-specs"></pre>
<a id="var-source" href="https://github.com/clojure/data.codec/blob/766746c11459a70cab27f7e0668a0be1f35fd679/src/main/clojure/clojure/data/codec/base64.clj#L260">Source</a>
@@ -165,6 +172,7 @@ <h2 id="clojure.data.codec.base64/enc-length">enc-length</h2>
<pre id="var-usage">Usage: (enc-length n)
</pre>
<pre id="var-docstr">Calculates what would be the length after encoding of an input array of length n.</pre>
+ <pre id="var-specs"></pre>
<a id="var-source" href="https://github.com/clojure/data.codec/blob/766746c11459a70cab27f7e0668a0be1f35fd679/src/main/clojure/clojure/data/codec/base64.clj#L31">Source</a>
@@ -177,6 +185,7 @@ <h2 id="clojure.data.codec.base64/encode">encode</h2>
(encode input offset length)
</pre>
<pre id="var-docstr">Returns a base64 encoded byte array.</pre>
+ <pre id="var-specs"></pre>
<a id="var-source" href="https://github.com/clojure/data.codec/blob/766746c11459a70cab27f7e0668a0be1f35fd679/src/main/clojure/clojure/data/codec/base64.clj#L230">Source</a>
@@ -192,6 +201,7 @@ <h2 id="clojure.data.codec.base64/encode!">encode!</h2>
length written to output.
Note: if using partial input, length must be a multiple of 3 to avoid padding.</pre>
+ <pre id="var-specs"></pre>
<a id="var-source" href="https://github.com/clojure/data.codec/blob/766746c11459a70cab27f7e0668a0be1f35fd679/src/main/clojure/clojure/data/codec/base64.clj#L151">Source</a>
@@ -206,6 +216,7 @@ <h2 id="clojure.data.codec.base64/encoding-transfer">encoding-transfer</h2>
Options are key/value pairs and may be one of
:buffer-size read buffer size to use, must be a multiple of 3; default is 6144.</pre>
+ <pre id="var-specs"></pre>
<a id="var-source" href="https://github.com/clojure/data.codec/blob/766746c11459a70cab27f7e0668a0be1f35fd679/src/main/clojure/clojure/data/codec/base64.clj#L278">Source</a>
@@ -217,6 +228,7 @@ <h2 id="clojure.data.codec.base64/pad-length">pad-length</h2>
<pre id="var-usage">Usage: (pad-length input offset length)
</pre>
<pre id="var-docstr">Returns the length of padding on the end of the input array.</pre>
+ <pre id="var-specs"></pre>
<a id="var-source" href="https://github.com/clojure/data.codec/blob/766746c11459a70cab27f7e0668a0be1f35fd679/src/main/clojure/clojure/data/codec/base64.clj#L49">Source</a>

0 comments on commit 7f6b08f

Please sign in to comment.