Add more specs and types

An incorrect spec, rpc:yield/1, has been fixed.

1 files changed, 90 insertions, 45 deletions

diff --git a/lib/kernel/src/code.erl b/lib/kernel/src/code.erl
index b0f99305f2..882e9625fe 100644
--- a/lib/kernel/src/code.erl
+++ b/lib/kernel/src/code.erl
@@ -82,7 +82,8 @@
 %% add_pathsa([Dir])             -> ok
 %% add_pathsz([Dir])             -> ok
 %% del_path(Dir)		 -> boolean() | {error, bad_name}
-%% replace_path(Name, Dir)       -> true | replace_path_error()
+%% replace_path(Name, Dir)       -> true | {error, bad_directory | bad_name
+%%                                                 | {badarg,_}}
 %% load_file(Module)		 -> {module, Module} | {error, What :: atom()}
 %% load_abs(File)		 -> {module, Module} | {error, What :: atom()}
 %% load_abs(File, Module)	 -> {module, Module} | {error, What :: atom()}
@@ -113,11 +114,16 @@
 %% Some types for basic exported functions of this module
 %%----------------------------------------------------------------------------
 
--type load_error_rsn() :: 'badfile' | 'native_code' | 'nofile' | 'not_purged'
-		        | 'sticky_directory'.	% for some functions only
--type load_ret() :: {'error', load_error_rsn()} | {'module', atom()}.
+-type load_error_rsn() :: 'badfile'
+                        | 'native_code'
+                        | 'nofile'
+                        | 'not_purged'
+                        | 'on_load'
+                        | 'sticky_directory'.
+-type load_ret() :: {'error', What :: load_error_rsn()}
+                  | {'module', Module :: module()}.
 -type loaded_ret_atoms() :: 'cover_compiled' | 'preloaded'.
--type loaded_filename() :: file:filename() | loaded_ret_atoms().
+-type loaded_filename() :: (Filename :: file:filename()) | loaded_ret_atoms().
 
 %%----------------------------------------------------------------------------
 %% User interface
@@ -127,55 +133,74 @@
 objfile_extension() ->
     init:objfile_extension().
 
--spec load_file(Module :: atom()) -> load_ret(). 
+-spec load_file(Module) -> load_ret() when
+      Module :: module().
 load_file(Mod) when is_atom(Mod) ->
     call({load_file,Mod}).
 
--spec ensure_loaded(Module :: atom()) -> load_ret().
+-spec ensure_loaded(Module) -> {module, Module} | {error, What} when
+      Module :: module(),
+      What :: embedded | badfile | native_code | nofile | on_load.
 ensure_loaded(Mod) when is_atom(Mod) -> 
     call({ensure_loaded,Mod}).
 
 %% XXX File as an atom is allowed only for backwards compatibility.
--spec load_abs(Filename :: file:filename()) -> load_ret().
+-spec load_abs(Filename) -> load_ret() when
+      Filename :: file:filename().
 load_abs(File) when is_list(File); is_atom(File) -> call({load_abs,File,[]}).
 
 %% XXX Filename is also an atom(), e.g. 'cover_compiled'
--spec load_abs(Filename :: loaded_filename(), Module :: atom()) -> load_ret().
+-spec load_abs(Filename :: loaded_filename(), Module :: module()) -> load_ret().
 load_abs(File, M) when (is_list(File) orelse is_atom(File)), is_atom(M) ->
     call({load_abs,File,M}).
 
 %% XXX Filename is also an atom(), e.g. 'cover_compiled'
--spec load_binary(Module :: atom(), Filename :: loaded_filename(), Binary :: binary()) -> load_ret().
+-spec load_binary(Module, Filename, Binary) ->
+                         {module, Module} | {error, What} when
+      Module :: module(),
+      Filename :: loaded_filename(),
+      Binary :: binary(),
+      What :: badarg | load_error_rsn().
 load_binary(Mod, File, Bin)
   when is_atom(Mod), (is_list(File) orelse is_atom(File)), is_binary(Bin) ->
     call({load_binary,Mod,File,Bin}).
 
--spec load_native_partial(Module :: atom(), Binary :: binary()) -> load_ret().
+-spec load_native_partial(Module :: module(), Binary :: binary()) -> load_ret().
 load_native_partial(Mod, Bin) when is_atom(Mod), is_binary(Bin) ->
     call({load_native_partial,Mod,Bin}).
 
--spec load_native_sticky(Module :: atom(), Binary :: binary(), WholeModule :: 'false' | binary()) -> load_ret().
+-spec load_native_sticky(Module :: module(), Binary :: binary(), WholeModule :: 'false' | binary()) -> load_ret().
 load_native_sticky(Mod, Bin, WholeModule)
   when is_atom(Mod), is_binary(Bin),
        (is_binary(WholeModule) orelse WholeModule =:= false) ->
     call({load_native_sticky,Mod,Bin,WholeModule}).
 
--spec delete(Module :: atom()) -> boolean().
+-spec delete(Module) -> boolean() when
+      Module :: module().
 delete(Mod) when is_atom(Mod) -> call({delete,Mod}).
 
--spec purge(Module :: atom()) -> boolean().
+-spec purge(Module) -> boolean() when
+      Module :: module().
 purge(Mod) when is_atom(Mod) -> call({purge,Mod}).
 
--spec soft_purge(Module :: atom()) -> boolean().
+-spec soft_purge(Module) -> boolean() when
+      Module :: module().
 soft_purge(Mod) when is_atom(Mod) -> call({soft_purge,Mod}).
 
--spec is_loaded(Module :: atom()) -> {'file', loaded_filename()} | 'false'.
+-spec is_loaded(Module) -> {'file', Loaded} | false when
+      Module :: module(),
+      Loaded :: loaded_filename().
 is_loaded(Mod) when is_atom(Mod) -> call({is_loaded,Mod}).
 
--spec get_object_code(Module :: atom()) -> {atom(), binary(), file:filename()} | 'error'.
+-spec get_object_code(Module) -> {Module, Binary, Filename} | error when
+      Module :: module(),
+      Binary :: binary(),
+      Filename :: file:filename().
 get_object_code(Mod) when is_atom(Mod) -> call({get_object_code, Mod}).
 
--spec all_loaded() -> [{atom(), loaded_filename()}].
+-spec all_loaded() -> [{Module, Loaded}] when
+      Module :: module(),
+      Loaded :: loaded_filename().
 all_loaded() -> call(all_loaded).
 
 -spec stop() -> no_return().
@@ -188,65 +213,86 @@ root_dir() -> call({dir,root_dir}).
 lib_dir() -> call({dir,lib_dir}).
 
 %% XXX is_list() is for backwards compatibility -- take out in future version
--spec lib_dir(App :: atom()) -> file:filename() | {'error', 'bad_name'}.
+-spec lib_dir(Name) -> file:filename() | {'error', 'bad_name'} when
+      Name :: atom().
 lib_dir(App) when is_atom(App) ; is_list(App) -> call({dir,{lib_dir,App}}).
 
--spec lib_dir(App :: atom(), SubDir :: atom()) -> file:filename() | {'error', 'bad_name'}.
+-spec lib_dir(Name, SubDir) -> file:filename() | {'error', 'bad_name'} when
+      Name :: atom(),
+      SubDir :: atom().
 lib_dir(App, SubDir) when is_atom(App), is_atom(SubDir) -> call({dir,{lib_dir,App,SubDir}}).
 
 -spec compiler_dir() -> file:filename().
 compiler_dir() -> call({dir,compiler_dir}).
 
 %% XXX is_list() is for backwards compatibility -- take out in future version
--spec priv_dir(App :: atom()) -> file:filename() | {'error', 'bad_name'}.
+-spec priv_dir(Name) -> file:filename() | {'error', 'bad_name'} when
+      Name :: atom().
 priv_dir(App) when is_atom(App) ; is_list(App) -> call({dir,{priv_dir,App}}).
 
--spec stick_dir(Directory :: file:filename()) -> 'ok' | 'error'.
+-spec stick_dir(Dir) -> 'ok' | 'error' when
+      Dir :: file:filename().
 stick_dir(Dir) when is_list(Dir) -> call({stick_dir,Dir}).
 
--spec unstick_dir(Directory :: file:filename()) -> 'ok' | 'error'.
+-spec unstick_dir(Dir) -> 'ok' | 'error' when
+      Dir :: file:filename().
 unstick_dir(Dir) when is_list(Dir) -> call({unstick_dir,Dir}).
 
--spec stick_mod(Module :: atom()) -> 'true'.
+-spec stick_mod(Module :: module()) -> 'true'.
 stick_mod(Mod) when is_atom(Mod) -> call({stick_mod,Mod}).
 
--spec unstick_mod(Module :: atom()) -> 'true'.
+-spec unstick_mod(Module :: module()) -> 'true'.
 unstick_mod(Mod) when is_atom(Mod) -> call({unstick_mod,Mod}).
 
--spec is_sticky(Module :: atom()) -> boolean().
+-spec is_sticky(Module) -> boolean() when
+      Module :: module().
 is_sticky(Mod) when is_atom(Mod) -> call({is_sticky,Mod}).
 
--spec set_path(Directories :: [file:filename()]) ->
-	'true' | {'error', 'bad_directory' | 'bad_path'}.
+-spec set_path(Path) -> 'true' | {'error', What} when
+      Path :: [Dir :: file:filename()],
+      What :: 'bad_directory' | 'bad_path'.
 set_path(PathList) when is_list(PathList) -> call({set_path,PathList}).
 
--spec get_path() -> [file:filename()].
+-spec get_path() -> Path when
+      Path :: [Dir :: file:filename()].
 get_path() -> call(get_path).
 
 -type add_path_ret() :: 'true' | {'error', 'bad_directory'}.
--spec add_path(Directory :: file:filename()) -> add_path_ret().
+-spec add_path(Dir) -> add_path_ret() when
+      Dir :: file:filename().
 add_path(Dir) when is_list(Dir) -> call({add_path,last,Dir}).
 
--spec add_pathz(Directory :: file:filename()) -> add_path_ret().
+-spec add_pathz(Dir) -> add_path_ret() when
+      Dir :: file:filename().
 add_pathz(Dir) when is_list(Dir) -> call({add_path,last,Dir}).
 
--spec add_patha(Directory :: file:filename()) -> add_path_ret().
+-spec add_patha(Dir) -> add_path_ret() when
+      Dir :: file:filename().
 add_patha(Dir) when is_list(Dir) -> call({add_path,first,Dir}).
 
--spec add_paths(Directories :: [file:filename()]) -> 'ok'.
+-spec add_paths(Dirs) -> 'ok' when
+      Dirs :: [Dir :: file:filename()].
 add_paths(Dirs) when is_list(Dirs) -> call({add_paths,last,Dirs}).
 
--spec add_pathsz(Directories :: [file:filename()]) -> 'ok'.
+-spec add_pathsz(Dirs) -> 'ok' when
+      Dirs :: [Dir :: file:filename()].
 add_pathsz(Dirs) when is_list(Dirs) -> call({add_paths,last,Dirs}).
 
--spec add_pathsa(Directories :: [file:filename()]) -> 'ok'.
+-spec add_pathsa(Dirs) -> 'ok' when
+      Dirs :: [Dir :: file:filename()].
 add_pathsa(Dirs) when is_list(Dirs) -> call({add_paths,first,Dirs}).
 
--spec del_path(Name :: file:filename() | atom()) -> boolean() | {'error', 'bad_name'}.
+-spec del_path(NameOrDir) -> boolean() | {'error', What} when
+      NameOrDir :: Name | Dir,
+      Name :: atom(),
+      Dir :: file:filename(),
+      What :: 'bad_name'.
 del_path(Name) when is_list(Name) ; is_atom(Name) -> call({del_path,Name}).
 
--type replace_path_error() :: {'error', 'bad_directory' | 'bad_name' | {'badarg',_}}.
--spec replace_path(Name:: atom(), Dir :: file:filename()) -> 'true' | replace_path_error().
+-spec replace_path(Name, Dir) -> 'true' | {'error', What} when
+      Name:: atom(),
+      Dir :: file:filename(),
+      What :: 'bad_directory' | 'bad_name' | {'badarg',_}.
 replace_path(Name, Dir) when (is_atom(Name) orelse is_list(Name)),
 			     (is_atom(Dir) orelse is_list(Dir)) ->
     call({replace_path,Name,Dir}).
@@ -351,10 +397,9 @@ get_mode(Flags) ->
 %% In that case return the name of the file which contains
 %% the loaded object code
 
--type which_ret_atoms() :: loaded_ret_atoms() | 'non_existing'.
-
--spec which(Module :: atom()) -> file:filename() | which_ret_atoms().
-
+-spec which(Module) -> Which when
+      Module :: module(),
+      Which :: file:filename() | loaded_ret_atoms() | non_existing.
 which(Module) when is_atom(Module) ->
     case is_loaded(Module) of
 	false ->
@@ -394,9 +439,9 @@ which(File, Base, [Directory|Tail]) ->
 %% Search the code path for a specific file. Try to locate
 %% it in the code path cache if possible.
 
--spec where_is_file(Filename :: file:filename()) ->
-        'non_existing' | file:filename().
-
+-spec where_is_file(Filename) -> non_existing | Absname when
+      Filename :: file:filename(),
+      Absname :: file:filename().
 where_is_file(File) when is_list(File) ->
     case call({is_cached,File}) of
 	no ->