Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

erlang: first beta documentation

  • Loading branch information...
commit a20046f4a3deec0e4e15ce9fcb450e0874e9aaa4 1 parent 58c45a5
UENISHI Kota authored
View
2  edoc/edoc-info
@@ -0,0 +1,2 @@
+{packages,[]}.
+{modules,[msgpack]}.
View
BIN  edoc/erlang.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
View
17 edoc/index.html
@@ -0,0 +1,17 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<title>Overview</title>
+</head>
+<frameset cols="20%,80%">
+<frame src="modules-frame.html" name="modulesFrame" title="">
+
+<frame src="overview-summary.html" name="overviewFrame" title="">
+<noframes>
+<h2>This page uses frames</h2>
+<p>Your browser does not accept frames.
+<br>You should go to the <a href="overview-summary.html">non-frame version</a> instead.
+</p>
+</noframes>
+</frameset>
+</html>
View
12 edoc/modules-frame.html
@@ -0,0 +1,12 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<title>Overview</title>
+<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
+</head>
+<body bgcolor="white">
+<h2 class="indextitle">Modules</h2>
+<table width="100%" border="0" summary="list of modules">
+<tr><td><a href="msgpack.html" target="overviewFrame" class="module">msgpack</a></td></tr></table>
+</body>
+</html>
View
71 edoc/msgpack.html
@@ -0,0 +1,71 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<title>Module msgpack</title>
+<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
+</head>
+<body bgcolor="white">
+<div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
+<hr>
+
+<h1>Module msgpack</h1>
+<ul class="index"><li><a href="#description">Description</a></li><li><a href="#types">Data Types</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul><a href="http://msgpack.org/">MessagePack</a> codec for Erlang.
+
+
+<h2><a name="description">Description</a></h2><p><a href="http://msgpack.org/">MessagePack</a> codec for Erlang.</p>
+
+ <p>APIs are almost compatible with <a href="http://redmine.msgpack.org/projects/msgpack/wiki/QuickStartC">C API</a>
+except for buffering functions (both copying and zero-copying), which are unavailable.</p>
+
+ <table border="1">
+ <caption>Equivalence between Erlang and <a href="http://msgpack.sourceforge.jp/spec">Msgpack type</a> :</caption>
+ <tr><th> erlang </th><th> msgpack </th></tr>
+ <tr><td> integer() </td><td> pos_fixnum/neg_fixnum/uint8/uint16/uint32/uint64/int8/int16/int32/int64 </td></tr>
+ <tr><td> float() </td><td> float/double </td></tr>
+ <tr><td> nil </td><td> nil </td></tr>
+ <tr><td> boolean() </td><td> boolean </td></tr>
+ <tr><td> binary() </td><td> fix_raw/raw16/raw32 </td></tr>
+ <tr><td> list() </td><td> fix_array/array16/array32 </td></tr>
+ <tr><td> {proplist()} </td><td> fix_map/map16/map32 </td></tr>
+ </table>
+<h2><a name="types">Data Types</a></h2>
+
+<h3 class="typedecl"><a name="type-msgpack_term">msgpack_term()</a></h3>
+<p><tt>msgpack_term() = [<a href="#type-msgpack_term">msgpack_term()</a>] | {[{<a href="#type-msgpack_term">msgpack_term()</a>, <a href="#type-msgpack_term">msgpack_term()</a>}]} | integer() | float() | binary()</tt></p>
+<p>Erlang representation of msgpack data.</p>
+
+<h2><a name="index">Function Index</a></h2>
+<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#pack-1">pack/1</a></td><td>Encode an erlang term into an msgpack binary.</td></tr>
+<tr><td valign="top"><a href="#unpack-1">unpack/1</a></td><td>Decode an msgpack binary into an erlang term.</td></tr>
+<tr><td valign="top"><a href="#unpack_all-1">unpack_all/1</a></td><td>Decode an msgpack binary into an erlang terms.</td></tr>
+</table>
+
+<h2><a name="functions">Function Details</a></h2>
+
+<h3 class="function"><a name="pack-1">pack/1</a></h3>
+<div class="spec">
+<p><tt>pack(Term::<a href="#type-msgpack_term">msgpack_term()</a>) -&gt; binary() | {error, {badarg, term()}}</tt></p>
+</div><p>Encode an erlang term into an msgpack binary.
+ Returns {error, {badarg, term()}} if the input is illegal.</p>
+
+<h3 class="function"><a name="unpack-1">unpack/1</a></h3>
+<div class="spec">
+<p><tt>unpack(Bin::binary()) -&gt; {<a href="#type-msgpack_term">msgpack_term()</a>, binary()} | {error, incomplete} | {error, {badarg, term()}}</tt></p>
+</div><p>Decode an msgpack binary into an erlang term.
+ It only decodes the first msgpack packet contained in the binary; the rest is returned as is.
+ Returns {error, {badarg, term()}} if the input is corrupted.
+ Returns {error, incomplete} if the input is not a full msgpack packet (caller should gather more data and try again).</p>
+
+<h3 class="function"><a name="unpack_all-1">unpack_all/1</a></h3>
+<div class="spec">
+<p><tt>unpack_all(Data::binary()) -&gt; [<a href="#type-msgpack_term">msgpack_term()</a>] | {error, incomplete} | {error, {badarg, term()}}</tt></p>
+</div><p>Decode an msgpack binary into an erlang terms.
+ It only decodes ALL msgpack packets contained in the binary. No packets should not remain.
+ Returns {error, {badarg, term()}} if the input is corrupted.
+ Returns {error, incomplete} if the input is not a full msgpack packet (caller should gather more data and try again).</p>
+<hr>
+
+<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
+<p><i>Generated by EDoc, Jul 18 2010, 23:54:10.</i></p>
+</body>
+</html>
View
15 edoc/overview-summary.html
@@ -0,0 +1,15 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<title>Overview</title>
+<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
+</head>
+<body bgcolor="white">
+<div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
+<h1>Overview</h1>
+
+<hr>
+<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
+<p><i>Generated by EDoc, Jul 18 2010, 23:54:11.</i></p>
+</body>
+</html>
View
11 edoc/packages-frame.html
@@ -0,0 +1,11 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<title>Overview</title>
+<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
+</head>
+<body bgcolor="white">
+<h2 class="indextitle">Packages</h2>
+<table width="100%" border="0" summary="list of packages"></table>
+</body>
+</html>
View
55 edoc/stylesheet.css
@@ -0,0 +1,55 @@
+/* standard EDoc style sheet */
+body {
+ font-family: Verdana, Arial, Helvetica, sans-serif;
+ margin-left: .25in;
+ margin-right: .2in;
+ margin-top: 0.2in;
+ margin-bottom: 0.2in;
+ color: #000000;
+ background-color: #ffffff;
+}
+h1,h2 {
+ margin-left: -0.2in;
+}
+div.navbar {
+ background-color: #add8e6;
+ padding: 0.2em;
+}
+h2.indextitle {
+ padding: 0.4em;
+ background-color: #add8e6;
+}
+h3.function,h3.typedecl {
+ background-color: #add8e6;
+ padding-left: 1em;
+}
+div.spec {
+ margin-left: 2em;
+ background-color: #eeeeee;
+}
+a.module,a.package {
+ text-decoration:none
+}
+a.module:hover,a.package:hover {
+ background-color: #eeeeee;
+}
+ul.definitions {
+ list-style-type: none;
+}
+ul.index {
+ list-style-type: none;
+ background-color: #eeeeee;
+}
+
+/*
+ * Minor style tweaks
+ */
+ul {
+ list-style-type: square;
+}
+table {
+ border-collapse: collapse;
+}
+td {
+ padding: 3
+}
Please sign in to comment.
Something went wrong with that request. Please try again.