aboutsummaryrefslogtreecommitdiffstats
path: root/lib/edoc/src/edoc_data.erl
diff options
context:
space:
mode:
authorHans Bolinder <[email protected]>2011-03-10 13:00:30 +0100
committerHans Bolinder <[email protected]>2011-03-10 13:00:30 +0100
commit839e24abdcc3e5a16ac78eb45e09736370e596fe (patch)
tree144fcf14894c8a5c7df3778d7b1d91fa6a72a1cb /lib/edoc/src/edoc_data.erl
parentcc5885e81da81dc52bd7890ff3612a48d2f4a9f2 (diff)
parent8052b98f596db048467c0c57cbaac1d3a27687ad (diff)
downloadotp-839e24abdcc3e5a16ac78eb45e09736370e596fe.tar.gz
otp-839e24abdcc3e5a16ac78eb45e09736370e596fe.tar.bz2
otp-839e24abdcc3e5a16ac78eb45e09736370e596fe.zip
Merge branch 'hb/edoc/specs_and_types/OTP-8525' into dev
* hb/edoc/specs_and_types/OTP-8525: Make Erlang specifications and types available in EDoc
Diffstat (limited to 'lib/edoc/src/edoc_data.erl')
-rw-r--r--lib/edoc/src/edoc_data.erl16
1 files changed, 13 insertions, 3 deletions
diff --git a/lib/edoc/src/edoc_data.erl b/lib/edoc/src/edoc_data.erl
index 124f8eb9a1..27f43dca5a 100644
--- a/lib/edoc/src/edoc_data.erl
+++ b/lib/edoc/src/edoc_data.erl
@@ -20,7 +20,7 @@
%% @copyright 2003 Richard Carlsson
%% @author Richard Carlsson <[email protected]>
%% @see edoc
-%% @end
+%% @end
%% =====================================================================
%% @doc Building the EDoc external data structure. See the file
@@ -30,9 +30,10 @@
-export([module/4, package/4, overview/4, type/2]).
+-export([hidden_filter/2, get_all_tags/1]).
+
-include("edoc.hrl").
-%% TODO: report multiple definitions of the same type in the same module.
%% TODO: check that variables in @equiv are found in the signature
%% TODO: copy types from target (if missing) when using @equiv
@@ -139,6 +140,15 @@ functions(Es, Env, Opts) ->
|| #entry{name = {_,_}=N, args = As, export = Export, data = Ts}
<- Es].
+hidden_filter(Es, Opts) ->
+ Private = proplists:get_bool(private, Opts),
+ Hidden = proplists:get_bool(hidden, Opts),
+ [E || E <- Es,
+ case E#entry.name of
+ {_, _} -> function_filter(E, Private, Hidden);
+ _ -> true
+ end].
+
function_filter(Es, Opts) ->
Private = proplists:get_bool(private, Opts),
Hidden = proplists:get_bool(hidden, Opts),
@@ -298,7 +308,7 @@ get_deprecated(Ts, F, A, Env) ->
case otp_internal:obsolete(M, F, A) of
{Tag, Text} when Tag =:= deprecated; Tag =:= removed ->
deprecated([Text]);
- {Tag, Repl, _Rel} when Tag =:= deprecated; Tag =:= removed ->
+ {Tag, Repl, _Rel} when Tag =:= deprecated; Tag =:= removed ->
deprecated(Repl, Env);
_ ->
[]