Permalink
Browse files

Removed reference documentation for BERT.

  • Loading branch information...
1 parent 09d1bea commit 36fdfb5edd87f6ef55c75f1a7870294626aded61 @flambard committed Nov 30, 2012
Showing with 2 additions and 380 deletions.
  1. +0 −376 doc/bert_reference.html
  2. +1 −2 doc/index.html
  3. +1 −2 doc/reference.html
View
@@ -1,376 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" ?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml">
-
-<head>
- <title>BERT reference</title>
-</head>
-
-<body>
-
-<h1>BERT reference</h1>
-
-<p>Version 0.1.2.</p>
-
-<p>
- This is the reference document for BERT, which is part of CLERIC
- (Common Lisp Erlang Interface). It describes all symbols exported from the
- <code>BERT</code> package.
-</p>
-
-<p>The latest version of this document is available here:
- <a href="http://common-lisp.net/project/cleric/doc/bert_reference.html">
- http://common-lisp.net/project/cleric/doc/bert_reference.html
- </a>
-</p>
-
-<dl>
- <dt><a href="#BERT">The BERT package</a></dt>
- <dd><a href="#BERT_classes">Classes</a></dd>
- <dd><a href="#BERT_functions">Functions</a></dd>
- <dd><a href="#BERT_variables">Variables</a></dd>
- <dd><a href="#BERT_conditions">Conditions</a></dd>
-</dl>
-
-<hr>
-<a name="BERT" />
-<h2>The BERT package</h2>
-
-<p>
- CLERIC implements the <a href="http://bert-rpc.org/">BERT</a> binary data
- interchange format and exports these functions through the <code>BERT</code>
- package.
-</p>
-
-<a name="BERT_classes" />
-<h3>Classes</h3>
-
-<p>
- <a name="bert_bert-regex" />
- [Standard class]<br>
- <b>bert-regex</b><!-- </p> -->
- <blockquote>
- <p>Represents a BERT regex term.</p>
- </blockquote>
- <br>
-</p>
-
-<p>
- <a name="bert_bert-time" />
- [Standard class]<br>
- <b>bert-time</b>
- <blockquote>
- <p>Represents a BERT time term.</p>
- </blockquote>
- <br>
-</p>
-
-<p>
- <a name="bert_erlang-binary" />
- [Standard class]<br>
- <b>erlang-binary</b>
- <blockquote>
- Inherited from <code>CLERIC</code>.
- See <a href="cleric_reference.html#cleric_erlang-binary">
- <i>cleric:erlang-binary</i>
- </a>.
- </blockquote>
- <br>
-</p>
-
-<p>
- <a name="bert_erlang-tuple" />
- [Standard class]<br>
- <b>erlang-tuple</b>
- <blockquote>
- Inherited from <code>CLERIC</code>.
- See <a href="cleric_reference.html#cleric_erlang-tuple">
- <i>cleric:erlang-tuple</i>
- </a>.
- </blockquote>
- <br>
-</p>
-
-<a name="BERT_functions" />
-<h3>Functions</h3>
-
-<p>
- <a name="bert_arity" />
- [Generic function]<br>
- <b>arity</b> <i>tuple</i> => <i>size</i>
- <blockquote>
- <p>
- Inherited from <code>CLERIC</code>.
- See <a href="cleric_reference.html#cleric_arity"><i>cleric:arity</i></a>.
- </p>
- </blockquote>
- <br>
-</p>
-
-<p>
- <a name="bert_binary" />
- [Function]<br>
- <b>binary</b> <i><code>&amp;rest</code></i> <i>bytes</i> => <i>binary</i>
- <blockquote>
- <p>
- Inherited from <code>CLERIC</code>.
- See <a href="cleric_reference.html#cleric_binary">
- <i>cleric:binary</i>
- </a>.
- </p>
- </blockquote>
- <br>
-</p>
-
-<p>
- <a name="bert_binary-to-string" />
- [Function]<br>
- <b>binary-to-string</b> <i>binary</i> => <i>string</i>
- <blockquote>
- <p>
- Inherited from <code>CLERIC</code>.
- See <a href="cleric_reference.html#cleric_binary-to-string">
- <i>cleric:binary-to-string</i></a>.
- </p>
- </blockquote>
- <br>
-</p>
-
-<p>
- <a name="bert_bool" />
- [Function]<br>
- <b>bool</b> <i>value</i> => <i>bert-boolean</i>
- <blockquote>
- <p>
- Returns the value of <a href="#bert_true"><i>bert:true</i></a> if
- <i>value</i> is true, otherwise returns the value of
- <a href="#bert_false"><i>bert:false</i></a>.
- </p>
- </blockquote>
- <br>
-</p>
-
-<p>
- <a name="bert_bytes" />
- [Generic function]<br>
- <b>bytes</b> <i>binary</i> => <i>bytes</i>
- <blockquote>
- <p>
- Inherited from <code>CLERIC</code>.
- See <a href="cleric_reference.html#cleric_bytes"><i>cleric:bytes</i></a>.
- </p>
- </blockquote>
- <br>
-</p>
-
-<p>
- <a name="bert_bytes-to-binary" />
- [Function]<br>
- <b>bytes-to-binary</b> <i>bytes</i> => <i>binary</i>
- <blockquote>
- <p>
- Inherited from <code>CLERIC</code>.
- See <a href="cleric_reference.html#cleric_bytes-to-binary">
- <i>cleric:bytes-to-binary</i>
- </a>.
- </p>
- </blockquote>
- <br>
-</p>
-
-<p>
- <a name="bert_decode" />
- [Function]<br>
- <b>decode</b> <i>bytes</i> => <i>bert-term, position</i>
- <blockquote>
- <p>
- Decodes the sequence <i>bytes</i> into BERT terms. <i>position</i> is the
- number of bytes consumed from <i>bytes</i>.
- </p>
- </blockquote>
- <br>
-</p>
-
-<p>
- <a name="bert_elements" />
- [Generic function]<br>
- <b>elements</b> <i>tuple</i> => <i>vector</i>
- <blockquote>
- <p>
- Inherited from <code>CLERIC</code>.
- See <a href="cleric_reference.html#cleric_elements">
- <i>cleric:elements</i>
- </a>.
- </p>
- </blockquote>
- <br>
-</p>
-
-<p>
- <a name="bert_encode" />
- [Generic function]<br>
- <b>encode</b> <i>object</i> <i><code>&amp;key</code></i> <i>berp-header</i> => <i>bytes</i>
- <blockquote>
- <p>
- <i>berp-header</i> defaults to <code>NIL</code>.
- </p>
-
- <p>
- Encodes <i>object</i> according to <a href="http://bert-rpc.org/">BERT</a>
- into a vector of bytes. If <i>berp-header</i> is true the resulting byte
- vector is prepended with a BERP header, a four byte length header.
- </p>
- </blockquote>
- <br>
-</p>
-
-<p>
- <a name="bert_size" />
- [Generic function]<br>
- <b>size</b> <i>tuple-or-binary</i> => <i>size</i>
- <blockquote>
- <p>
- Inherited from <code>CLERIC</code>.
- See <a href="cleric_reference.html#cleric_size"><i>cleric:size</i></a>.
- </p>
- </blockquote>
- <br>
-</p>
-
-<p>
- <a name="bert_string-to-binary" />
- [Function]<br>
- <b>string-to-binary</b> <i>string</i> => <i>binary</i>
- <blockquote>
- <p>
- Inherited from <code>CLERIC</code>.
- See <a href="cleric_reference.html#cleric_string-to-binary">
- <i>cleric:string-to-binary</i>
- </a>.
- </p>
- </blockquote>
- <br>
-</p>
-
-<p>
- <a name="bert_tuple" />
- [Function]<br>
- <b>tuple</b> <i><code>&amp;rest</code></i> <i>objects</i> => <i>tuple</i>
- <blockquote>
- <p>
- Inherited from <code>CLERIC</code>.
- See <a href="cleric_reference.html#cleric_tuple"><i>cleric:tuple</i></a>.
- </p>
- </blockquote>
- <br>
-</p>
-
-<a name="BERT_variables" />
-<h3>Variables</h3>
-
-<p>
- <a name="bert_STatom-symbol-packageST" />
- [Special variable]<br>
- <b>*atom-symbol-package*</b>
- <blockquote>
- <p>
- Inherited from <code>CLERIC</code>.
- See <a href="cleric_reference.html#cleric_STatom-symbol-packageST">
- <i>cleric:*atom-symbol-package*</i>
- </a>.
- </p>
- </blockquote>
- <br>
-</p>
-
-<p>
- <a name="bert_STlisp-string-is-erlang-binaryST" />
- [Special variable]<br>
- <b>*lisp-string-is-erlang-binary*</b>
- <blockquote>
- <p>
- Inherited from <code>CLERIC</code>.
- See
- <a href="cleric_reference.html#cleric_STlisp-string-is-erlang-binaryST">
- <i>cleric:*lisp-string-is-erlang-binary*</i>
- </a>.
- </p>
- </blockquote>
- <br>
-</p>
-
-<p>
- <a name="bert_false" />
- [Constant variable]<br>
- <b>false</b>
- <blockquote>
- <p>
- Value: <code>#&lt;ERLANG-TUPLE {|bert| |false|}&gt;</code>
- </p>
- </blockquote>
- <br>
-</p>
-
-<p>
- <a name="bert_true" />
- [Constant variable]<br>
- <b>true</b>
- <blockquote>
- <p>
- Value: <code>#&lt;ERLANG-TUPLE {|bert| |true|}&gt;</code>
- </p>
- </blockquote>
- <br>
-</p>
-
-<a name="BERT_conditions" />
-<h3>Conditions</h3>
-
-<p>
- <a name="bert_unexpected-message-length-error" />
- [Condition]<br>
- <b>unexpected-message-length-error</b>
- <blockquote>
- <p>
- Inherited from <code>CLERIC</code>.
- See
- <a href="cleric_reference.html#cleric_unexpected-message-length-error">
- <i>cleric:unexpected-message-length-error</i>
- </a>.
- </p>
- </blockquote>
- <br>
-</p>
-
-<p>
- <a name="bert_unexpected-message-tag-error" />
- [Condition]<br>
- <b>unexpected-message-tag-error</b>
- <blockquote>
- <p>
- Inherited from <code>CLERIC</code>.
- See <a href="cleric_reference.html#cleric_unexpected-message-tag-error">
- <i>cleric:unexpected-message-tag-error</i>
- </a>.
- </p>
- </blockquote>
- <br>
-</p>
-
-<p>
- <a name="bert_untranslatable-lisp-object-error" />
- [Condition]<br>
- <b>untranslatable-lisp-object-error</b>
- <blockquote>
- <p>
- Inherited from <code>CLERIC</code>.
- See
- <a href="cleric_reference.html#cleric_untranslatable-lisp-object-error">
- <i>cleric:untranslatable-lisp-object-error</i>
- </a>.
- </p>
- </blockquote>
- <br>
-</p>
View
@@ -21,8 +21,7 @@
</p>
<blockquote>
- <a href="cleric_reference.html">CLERIC reference</a><br>
- <a href="bert_reference.html">BERT reference</a>
+ <a href="cleric_reference.html">CLERIC reference</a>
</blockquote>
</body>
View
@@ -21,6 +21,5 @@
</p>
<blockquote>
- <a href="cleric_reference.html">CLERIC reference</a><br>
- <a href="bert_reference.html">BERT reference</a>
+ <a href="cleric_reference.html">CLERIC reference</a>
</blockquote>

0 comments on commit 36fdfb5

Please sign in to comment.