From 90b3eb809e0c399593c741b2281d89498e87b147 Mon Sep 17 00:00:00 2001 From: Kostis Sagonas Date: Mon, 17 Dec 2012 11:09:15 +0100 Subject: Ensure that edocumentation and the xml file are in sync --- lib/stdlib/src/proplists.erl | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) (limited to 'lib/stdlib/src/proplists.erl') diff --git a/lib/stdlib/src/proplists.erl b/lib/stdlib/src/proplists.erl index 4df4669291..204f8e128c 100644 --- a/lib/stdlib/src/proplists.erl +++ b/lib/stdlib/src/proplists.erl @@ -57,9 +57,9 @@ %% --------------------------------------------------------------------- %% @doc Creates a normal form (minimal) representation of a property. If -%% P is {Key, true} where Key is -%% an atom, this returns Key, otherwise the whole term -%% P is returned. +%% PropertyIn is {Key, true} where +%% Key is an atom, this returns Key, otherwise +%% the whole term PropertyIn is returned. %% %% @see property/2 @@ -93,7 +93,7 @@ property(Key, Value) -> %% --------------------------------------------------------------------- -%% @doc Unfolds all occurences of atoms in List to tuples +%% @doc Unfolds all occurences of atoms in ListIn to tuples %% {Atom, true}. %% %% @see compact/1 @@ -112,7 +112,7 @@ unfold([]) -> []. %% @doc Minimizes the representation of all entries in the list. This is -%% equivalent to [property(P) || P <- List]. +%% equivalent to [property(P) || P <- ListIn]. %% %% @see unfold/1 %% @see property/1 @@ -121,8 +121,8 @@ unfold([]) -> ListIn :: [property()], ListOut :: [property()]. -compact(List) -> - [property(P) || P <- List]. +compact(ListIn) -> + [property(P) || P <- ListIn]. %% --------------------------------------------------------------------- @@ -378,7 +378,7 @@ delete(_, []) -> %% --------------------------------------------------------------------- %% @doc Substitutes keys of properties. For each entry in -%% List, if it is associated with some key K1 +%% ListIn, if it is associated with some key K1 %% such that {K1, K2} occurs in Aliases, the %% key of the entry is changed to Key2. If the same %% K1 occurs more than once in Aliases, only @@ -416,13 +416,13 @@ substitute_aliases_1([], P) -> %% --------------------------------------------------------------------- %% @doc Substitutes keys of boolean-valued properties and simultaneously -%% negates their values. For each entry in List, if it is +%% negates their values. For each entry in ListIn, if it is %% associated with some key K1 such that {K1, %% K2} occurs in Negations, then if the entry was %% {K1, true} it will be replaced with {K2, %% false}, otherwise it will be replaced with {K2, %% true}, thus changing the name of the option and simultaneously -%% negating the value given by get_bool(List). If the same +%% negating the value given by get_bool(ListIn). If the same %% K1 occurs more than once in Negations, only %% the first occurrence is used. %% @@ -472,11 +472,11 @@ substitute_negations_1([], P) -> %% @doc Expands particular properties to corresponding sets of %% properties (or other terms). For each pair {Property, %% Expansion} in Expansions, if E is -%% the first entry in List with the same key as +%% the first entry in ListIn with the same key as %% Property, and E and Property %% have equivalent normal forms, then E is replaced with %% the terms in Expansion, and any following entries with -%% the same key are deleted from List. +%% the same key are deleted from ListIn. %% %%

For example, the following expressions all return [fie, bar, %% baz, fum]: -- cgit v1.2.3