From 5f9ad541eb520162d86bdc5bcf58e235ced7e786 Mon Sep 17 00:00:00 2001
From: Richard Carlsson <richardc@klarna.com>
Date: Tue, 17 Jul 2012 18:32:31 +0200
Subject: documentation fixes
---
lib/eunit/doc/overview.edoc | 5 +++--
lib/eunit/src/eunit_data.erl | 3 +--
lib/eunit/src/eunit_lib.erl | 5 +----
3 files changed, 5 insertions(+), 8 deletions(-)
(limited to 'lib/eunit')
diff --git a/lib/eunit/doc/overview.edoc b/lib/eunit/doc/overview.edoc
index 42d70a6963..b4af31ae6a 100644
--- a/lib/eunit/doc/overview.edoc
+++ b/lib/eunit/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.
diff --git a/lib/eunit/src/eunit_data.erl b/lib/eunit/src/eunit_data.erl
index 0222becb18..0350f9bf6e 100644
--- a/lib/eunit/src/eunit_data.erl
+++ b/lib/eunit/src/eunit_data.erl
@@ -96,7 +96,6 @@
%%
%% @type moduleName() = atom()
%% @type functionName() = atom()
-%% @type arity() = integer()
%% @type appName() = atom()
%% @type fileName() = string()
@@ -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(),
diff --git a/lib/eunit/src/eunit_lib.erl b/lib/eunit/src/eunit_lib.erl
index f0fd26eb5d..ea9e944d7e 100644
--- a/lib/eunit/src/eunit_lib.erl
+++ b/lib/eunit/src/eunit_lib.erl
@@ -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()
--
cgit v1.2.3