Browse files

documentation fixes

  • Loading branch information...
1 parent 4e278d6 commit 5dd5035bf912a6068053b0855127fdf684ebe667 Richard Carlsson committed Jul 17, 2012
Showing with 5 additions and 8 deletions.
  1. +3 −2 doc/overview.edoc
  2. +1 −2 src/eunit_data.erl
  3. +1 −4 src/eunit_lib.erl
View
5 doc/overview.edoc
@@ -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.
View
3 src/eunit_data.erl
@@ -101,7 +101,6 @@
%%
%% @type moduleName() = atom()
%% @type functionName() = atom()
-%% @type arity() = integer()
%% @type appName() = atom()
%% @type fileName() = string()
@@ -164,7 +163,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(),
View
5 src/eunit_lib.erl
@@ -45,13 +45,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()

0 comments on commit 5dd5035

Please sign in to comment.