Added some EDocs

yrashk · Feb 21, 2011 · 1902893 · 1902893
1 parent eae97d4
commit 1902893
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,4 @@ priv
 c_src/*.o
 ebin
 .eunit
+doc
diff --git a/src/ossp_uuid.erl b/src/ossp_uuid.erl
@@ -16,12 +16,30 @@ init() ->
             Err
     end.
 
+%% ----------------------------------
+%% @doc 
+%% Generate UUID
+%% @spec make(Version::(v1|v4), Format::text|binary) -> binary()
+%% @end
+%% ----------------------------------
 make(_Mode, _Format) ->
     erlang:nif_error(not_loaded).
 
+%% ----------------------------------
+%% @doc 
+%% Generate UUID
+%% @spec make(Version::(v3|v5), Format::text|binary, NS::string(), Name::string()) -> binary()
+%% @end
+%% ----------------------------------
 make(_Mode, _Format, _NS, _Name) ->
     erlang:nif_error(not_loaded).
 
+%% ----------------------------------
+%% @doc 
+%% Import UUID
+%% @spec import(UUID::iolist(), Format::text|binary) -> binary()
+%% @end
+%% ----------------------------------
 import(_IOList, _Format) ->
     erlang:nif_error(not_loaded).