Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Update doc

  • Loading branch information...
commit 613e6561964458eb5ce2b0dca4c49b31c257f486 1 parent 33f62b2
@krestenkrab authored
Showing with 48 additions and 7 deletions.
  1. +48 −7 doc/emmap.md
View
55 doc/emmap.md
@@ -1,18 +1,40 @@
#Module emmap#
+* [Data Types](#types)
* [Function Index](#index)
* [Function Details](#functions)
+
+<a name="types"></a>
+
+##Data Types##
+
+
+
+
+###<a name="type-mmap_file">mmap_file()</a>##
+
+
+
+<pre>mmap_file() = #file_descriptor{}</pre>
+
+
+
+###<a name="type-open_option">open_option()</a>##
+
+
+
+<pre>open_option() = read | write | direct | lock | nolock | private | shared | nocache</pre>
<a name="index"></a>
##Function Index##
-<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#close-1">close/1</a></td><td></td></tr><tr><td valign="top"><a href="#open-4">open/4</a></td><td></td></tr><tr><td valign="top"><a href="#position-2">position/2</a></td><td></td></tr><tr><td valign="top"><a href="#pread-3">pread/3</a></td><td></td></tr><tr><td valign="top"><a href="#pwrite-3">pwrite/3</a></td><td></td></tr><tr><td valign="top"><a href="#read-2">read/2</a></td><td></td></tr><tr><td valign="top"><a href="#simple_test-0">simple_test/0</a></td><td></td></tr></table>
+<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#close-1">close/1</a></td><td></td></tr><tr><td valign="top"><a href="#open-2">open/2</a></td><td></td></tr><tr><td valign="top"><a href="#open-4">open/4</a></td><td></td></tr><tr><td valign="top"><a href="#position-2">position/2</a></td><td></td></tr><tr><td valign="top"><a href="#pread-3">pread/3</a></td><td></td></tr><tr><td valign="top"><a href="#pwrite-3">pwrite/3</a></td><td></td></tr><tr><td valign="top"><a href="#read-2">read/2</a></td><td></td></tr><tr><td valign="top"><a href="#simple_test-0">simple_test/0</a></td><td></td></tr></table>
<a name="functions"></a>
@@ -26,7 +48,18 @@
-`close(File_descriptor) -> any()`
+<pre>close(File::<a href="#type-mmap_file">mmap_file()</a>) -> ok</pre>
+<br></br>
+
+
+<a name="open-2"></a>
+
+###open/2##
+
+
+
+
+`open(FileName, Options) -> any()`
<a name="open-4"></a>
@@ -35,7 +68,7 @@
-<pre>open(File::string(), Offset::pos_integer(), Length::pos_integer(), Options::[read | write | direct | nocache | private | shared]) -&gt; {ok, term()} | {error, term()}</pre>
+<pre>open(File::string(), Offset::pos_integer(), Length::pos_integer(), Options::[<a href="#type-open_option">open_option()</a>]) -> {ok, <a href="#type-mmap_file">mmap_file()</a>} | {error, term()}</pre>
<br></br>
@@ -46,7 +79,9 @@
-`position(File_descriptor, At) -> any()`
+<pre>position(File::<a href="#type-mmap_file">mmap_file()</a>, Position::pos_integer() | {bof | cur | eof, Position::integer()}) -> {ok, pos_integer()} | {error, term()}</pre>
+<br></br>
+
<a name="pread-3"></a>
@@ -55,7 +90,9 @@
-`pread(File_descriptor, Off, Len) -> any()`
+<pre>pread(File::<a href="#type-mmap_file">mmap_file()</a>, Offset::pos_integer(), Length::pos_integer()) -> {ok, binary()} | {error, term()} | eof</pre>
+<br></br>
+
<a name="pwrite-3"></a>
@@ -64,7 +101,9 @@
-`pwrite(File_descriptor, Off, Data) -> any()`
+<pre>pwrite(File::<a href="#type-mmap_file">mmap_file()</a>, Position::pos_integer(), Data::binary()) -> ok | {error, term()}</pre>
+<br></br>
+
<a name="read-2"></a>
@@ -73,7 +112,9 @@
-`read(File_descriptor, Len) -> any()`
+<pre>read(File::<a href="#type-mmap_file">mmap_file()</a>, Length::pos_integer()) -> {ok, binary()} | {error, term()} | eof</pre>
+<br></br>
+
<a name="simple_test-0"></a>
Please sign in to comment.
Something went wrong with that request. Please try again.