Skip to content

Commit

Permalink
documentation fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Richard Carlsson authored and rimmius committed Aug 10, 2012
1 parent 7b1897b commit 5f9ad54
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 8 deletions.
5 changes: 3 additions & 2 deletions lib/eunit/doc/overview.edoc
Expand Up @@ -726,8 +726,9 @@ A <em>simple test object</em> is one of the following:
<li>A tuple `{test, ModuleName, FunctionName}', where `ModuleName' and
`FunctionName' are atoms, referring to the function
`ModuleName:FunctionName/0'</li>
<li>Obsolete: a pair of atoms `{ModuleName, FunctionName}', equivalent to
`{test, ModuleName, FunctionName}' if nothing else matches first. </li>
<li>(Obsolete) A pair of atoms `{ModuleName, FunctionName}', equivalent to
`{test, ModuleName, FunctionName}' if nothing else matches first. This
might be removed in a future version.</li>
<li>A pair `{LineNumber, SimpleTest}', where `LineNumber' is a
nonnegative integer and `SimpleTest' is another simple test
object. `LineNumber' should indicate the source line of the test.
Expand Down
3 changes: 1 addition & 2 deletions lib/eunit/src/eunit_data.erl
Expand Up @@ -96,7 +96,6 @@
%%
%% @type moduleName() = atom()
%% @type functionName() = atom()
%% @type arity() = integer()
%% @type appName() = atom()
%% @type fileName() = string()

Expand Down Expand Up @@ -159,7 +158,7 @@ iter_prev(#iter{prev = [T | Ts]} = I) ->
%% @throws {bad_test, term()}
%% | {generator_failed, {{M::atom(),F::atom(),A::integer()},
%% exception()}}
%% | {no_such_function, eunit_lib:mfa()}
%% | {no_such_function, mfa()}
%% | {module_not_found, moduleName()}
%% | {application_not_found, appName()}
%% | {file_read_error, {Reason::atom(), Message::string(),
Expand Down
5 changes: 1 addition & 4 deletions lib/eunit/src/eunit_lib.erl
Expand Up @@ -40,13 +40,10 @@
%%
%% @type exceptionClass() = error | exit | throw
%%
%% @type stackTrace() = [{moduleName(), functionName(),
%% arity() | argList()}]
%% @type stackTrace() = [{moduleName(), functionName(), arity() | argList()}]
%%
%% @type moduleName() = atom()
%% @type functionName() = atom()
%% @type arity() = integer()
%% @type mfa() = {moduleName(), functionName(), arity()}
%% @type argList() = [term()]
%% @type fileName() = string()

Expand Down

0 comments on commit 5f9ad54

Please sign in to comment.