Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Add edoc/edown skeleton

  • Loading branch information...
commit 2f355a386e9d2f851248099af9a3f0f8284822c9 1 parent 4958f9f
@krestenkrab authored
Showing with 127 additions and 0 deletions.
  1. +22 −0 doc/README.md
  2. +86 −0 doc/emmap.md
  3. +11 −0 doc/overview.edoc
  4. +8 −0 rebar.config
View
22 doc/README.md
@@ -0,0 +1,22 @@
+
+
+#mmap - memory mapping files for erlang#
+
+
+Copyright (c) 2012 Trifork
+
+
+__Authors:__ Kresten Krab Thorup ([`krab@trifork.com`](mailto:krab@trifork.com)).
+
+
+Status:
+------
+
+
+
+##Modules##
+
+
+<table width="100%" border="0" summary="list of modules">
+<tr><td><a href="emmap.md" class="module">emmap</a></td></tr></table>
+
View
86 doc/emmap.md
@@ -0,0 +1,86 @@
+
+
+#Module emmap#
+* [Function Index](#index)
+* [Function Details](#functions)
+
+
+
+
+<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>
+
+
+<a name="functions"></a>
+
+##Function Details##
+
+<a name="close-1"></a>
+
+###close/1##
+
+
+
+
+`close(File_descriptor) -> any()`
+
+<a name="open-4"></a>
+
+###open/4##
+
+
+
+
+<pre>open(File::string(), Offset::pos_integer(), Length::pos_integer(), Options::[read | write | direct | nocache | private | shared]) -&gt; {ok, term()} | {error, term()}</pre>
+<br></br>
+
+
+<a name="position-2"></a>
+
+###position/2##
+
+
+
+
+`position(File_descriptor, At) -> any()`
+
+<a name="pread-3"></a>
+
+###pread/3##
+
+
+
+
+`pread(File_descriptor, Off, Len) -> any()`
+
+<a name="pwrite-3"></a>
+
+###pwrite/3##
+
+
+
+
+`pwrite(File_descriptor, Off, Data) -> any()`
+
+<a name="read-2"></a>
+
+###read/2##
+
+
+
+
+`read(File_descriptor, Len) -> any()`
+
+<a name="simple_test-0"></a>
+
+###simple_test/0##
+
+
+
+
+`simple_test() -> any()`
+
View
11 doc/overview.edoc
@@ -0,0 +1,11 @@
+@author Kresten Krab Thorup <krab@trifork.com>
+@copyright 2012 Trifork
+
+@title mmap - memory mapping files for erlang
+
+@doc
+Status:
+------
+
+
+@end
View
8 rebar.config
@@ -8,3 +8,11 @@
{"(linux|solaris|freebsd|netbsd|openbsd|dragonfly|darwin)",
"CFLAGS", "$CFLAGS -DNDEBUG"}
]}.
+
+{deps, [{edown, ".*", {git, "https://github.com/uwiger/edown.git", "HEAD"}}]}.
+
+{edoc_opts, [{doclet, edown_doclet},
+ {source_path, ["src", "test"]},
+ {stylesheet, ""},
+ {image, ""},
+ {app_default,"http://www.erlang.org/doc/man"}]}.
Please sign in to comment.
Something went wrong with that request. Please try again.