From 20cc39d443d1a2c364b0fb778c7813ae7b5a1dd6 Mon Sep 17 00:00:00 2001 From: Sverker Eriksson Date: Tue, 11 Dec 2018 17:42:39 +0100 Subject: Add "since" attributes in xml for new functions and modules introduced after OTP_R13B03. --- lib/stdlib/doc/src/beam_lib.xml | 4 +-- lib/stdlib/doc/src/binary.xml | 56 +++++++++++++++---------------- lib/stdlib/doc/src/c.xml | 10 +++--- lib/stdlib/doc/src/calendar.xml | 16 ++++----- lib/stdlib/doc/src/dict.xml | 4 +-- lib/stdlib/doc/src/epp.xml | 22 ++++++------- lib/stdlib/doc/src/erl_anno.xml | 36 ++++++++++---------- lib/stdlib/doc/src/erl_internal.xml | 2 +- lib/stdlib/doc/src/erl_parse.xml | 14 ++++---- lib/stdlib/doc/src/erl_scan.xml | 14 ++++---- lib/stdlib/doc/src/erl_tar.xml | 2 +- lib/stdlib/doc/src/ets.xml | 18 +++++----- lib/stdlib/doc/src/filelib.xml | 10 +++--- lib/stdlib/doc/src/filename.xml | 10 +++--- lib/stdlib/doc/src/gb_sets.xml | 2 +- lib/stdlib/doc/src/gb_trees.xml | 6 ++-- lib/stdlib/doc/src/gen_event.xml | 8 ++--- lib/stdlib/doc/src/gen_server.xml | 8 ++--- lib/stdlib/doc/src/gen_statem.xml | 48 +++++++++++++-------------- lib/stdlib/doc/src/io.xml | 12 +++---- lib/stdlib/doc/src/io_lib.xml | 28 ++++++++-------- lib/stdlib/doc/src/lists.xml | 8 ++--- lib/stdlib/doc/src/maps.xml | 50 ++++++++++++++-------------- lib/stdlib/doc/src/math.xml | 8 ++--- lib/stdlib/doc/src/orddict.xml | 4 +-- lib/stdlib/doc/src/ordsets.xml | 2 +- lib/stdlib/doc/src/proc_lib.xml | 8 ++--- lib/stdlib/doc/src/rand.xml | 38 ++++++++++----------- lib/stdlib/doc/src/re.xml | 4 +-- lib/stdlib/doc/src/sets.xml | 2 +- lib/stdlib/doc/src/shell.xml | 4 +-- lib/stdlib/doc/src/string.xml | 66 ++++++++++++++++++------------------- lib/stdlib/doc/src/supervisor.xml | 4 +-- lib/stdlib/doc/src/sys.xml | 16 ++++----- lib/stdlib/doc/src/timer.xml | 4 +-- lib/stdlib/doc/src/unicode.xml | 16 ++++----- lib/stdlib/doc/src/uri_string.xml | 18 +++++----- lib/stdlib/doc/src/zip.xml | 2 +- 38 files changed, 292 insertions(+), 292 deletions(-) (limited to 'lib/stdlib') diff --git a/lib/stdlib/doc/src/beam_lib.xml b/lib/stdlib/doc/src/beam_lib.xml index 213170df7f..473170c839 100644 --- a/lib/stdlib/doc/src/beam_lib.xml +++ b/lib/stdlib/doc/src/beam_lib.xml @@ -267,7 +267,7 @@ io:fwrite("~s~n", [erl_prettypr:format(erl_syntax:form_list(AC))]). - + Read all chunks from a BEAM file or binary

Reads chunk data for all chunks.

@@ -275,7 +275,7 @@ io:fwrite("~s~n", [erl_prettypr:format(erl_syntax:form_list(AC))]). - + Create a BEAM module from a list of chunks.

Builds a BEAM module (as a binary) from a list of chunks.

diff --git a/lib/stdlib/doc/src/binary.xml b/lib/stdlib/doc/src/binary.xml index 6a86d6c7ba..f3d4edd30f 100644 --- a/lib/stdlib/doc/src/binary.xml +++ b/lib/stdlib/doc/src/binary.xml @@ -34,7 +34,7 @@ A binary.xml - binary + binary Library for handling binary data. @@ -79,7 +79,7 @@ - + Return the byte at a specific position in a binary.

Returns the byte at position Pos (zero-based) in @@ -90,7 +90,7 @@ - + Convert a binary to a list of integers.

Same as bin_to_list(Subject, {0,byte_size(Subject)}).

@@ -98,7 +98,7 @@ - + Convert a binary to a list of integers.

Converts Subject to a list of byte()s, each @@ -118,7 +118,7 @@ - + Convert a binary to a list of integers.

Same as bin_to_list(Subject, {Pos, Len}).

@@ -126,7 +126,7 @@ - + Precompile a binary search pattern.

Builds an internal structure representing a compilation of a @@ -158,7 +158,7 @@ - + Create a duplicate of a binary.

Same as copy(Subject, 1).

@@ -166,7 +166,7 @@ - + Duplicate a binary N times and create a new.

Creates a binary with the content of Subject @@ -193,7 +193,7 @@ - + Decode a whole binary into an integer of arbitrary size. @@ -202,7 +202,7 @@ - + Decode a whole binary into an integer of arbitrary size. @@ -219,7 +219,7 @@ - + Encode an unsigned integer into the minimal binary.

Same as encode_unsigned(Unsigned, big).

@@ -227,7 +227,7 @@ - + Encode an unsigned integer into the minimal binary.

Converts a positive integer to the smallest possible @@ -243,7 +243,7 @@ - + Return the first byte of a binary.

Returns the first byte of binary Subject as an @@ -253,7 +253,7 @@ - + Return the last byte of a binary.

Returns the last byte of binary Subject as an @@ -263,7 +263,7 @@ - + Convert a list of integers and binaries to a binary.

Works exactly as @@ -273,7 +273,7 @@ - + Return length of longest common prefix for a set of binaries. @@ -294,7 +294,7 @@ - + Return length of longest common suffix for a set of binaries. @@ -315,7 +315,7 @@ - + Search for the first match of a pattern in a binary.

Same as match(Subject, Pattern, []). @@ -324,7 +324,7 @@ - + Search for the first match of a pattern in a binary. @@ -372,7 +372,7 @@ - + Search for all matches of a pattern in a binary.

Same as matches(Subject, Pattern, []). @@ -381,7 +381,7 @@ - + Search for all matches of a pattern in a binary. @@ -425,7 +425,7 @@ - + Extract a part of a binary.

Extracts the part of binary Subject described by @@ -453,7 +453,7 @@ - + Extract a part of a binary.

Same as part(Subject, {Pos, @@ -462,7 +462,7 @@ - + Determine the size of the binary pointed out by a subbinary. @@ -525,7 +525,7 @@ store(Binary, GBSet) -> - + Replace bytes in a binary according to a pattern.

Same as replace(Subject, Pattern, Replacement,[]).

@@ -533,7 +533,7 @@ store(Binary, GBSet) -> - + Replace bytes in a binary according to a pattern. An integer() =< byte_size(Replacement) @@ -575,7 +575,7 @@ store(Binary, GBSet) -> - + Split a binary according to a pattern.

Same as split(Subject, Pattern, @@ -584,7 +584,7 @@ store(Binary, GBSet) -> - + Split a binary according to a pattern.

Splits Subject into a list of binaries based on diff --git a/lib/stdlib/doc/src/c.xml b/lib/stdlib/doc/src/c.xml index b6cb6f5aae..40e6d9d43e 100644 --- a/lib/stdlib/doc/src/c.xml +++ b/lib/stdlib/doc/src/c.xml @@ -52,7 +52,7 @@ - + Compile and load a file or module.

Compiles and then purges and loads the code for a module. @@ -94,7 +94,7 @@ - + Load an erlang resource file.

Search PathList and load .erlang resource file if @@ -171,7 +171,7 @@ - + Loads all modified modules.

Reloads all currently loaded modules that have changed on disk (see mm()). @@ -214,7 +214,7 @@ - + Lists all modified modules.

Lists all modified modules. Shorthand for @@ -301,7 +301,7 @@ compile:file(File, Options ++ [report_errors, report_w - + Print node uptime.

Prints the node uptime (as specified by diff --git a/lib/stdlib/doc/src/calendar.xml b/lib/stdlib/doc/src/calendar.xml index 5aee635c38..0d2f3ab3d3 100644 --- a/lib/stdlib/doc/src/calendar.xml +++ b/lib/stdlib/doc/src/calendar.xml @@ -195,7 +195,7 @@ - + Compute the ISO week number for the actual date.

Returns tuple {Year, WeekNum} representing @@ -206,7 +206,7 @@ - + Compute the ISO week number for the specified date.

Returns tuple {Year, WeekNum} representing @@ -317,8 +317,8 @@ - - + + Convert from RFC 3339 timestamp to system time. @@ -365,7 +365,7 @@ - + Convert system time to local date and time.

Converts a specified system time into local date and time.

@@ -373,8 +373,8 @@ - - + + Convert from system to RFC 3339 timestamp. @@ -426,7 +426,7 @@ - + Convert system time to universal date and time.

Converts a specified system time into universal date and time.

diff --git a/lib/stdlib/doc/src/dict.xml b/lib/stdlib/doc/src/dict.xml index c229a18721..e35b64d5e2 100644 --- a/lib/stdlib/doc/src/dict.xml +++ b/lib/stdlib/doc/src/dict.xml @@ -106,7 +106,7 @@ - + Return value and new dictionary without element with this value.

This function returns value from dictionary and a @@ -162,7 +162,7 @@ - + Return true if the dictionary is empty.

Returns true if dictionary Dict has no diff --git a/lib/stdlib/doc/src/epp.xml b/lib/stdlib/doc/src/epp.xml index d803d259aa..d9eefc19e0 100644 --- a/lib/stdlib/doc/src/epp.xml +++ b/lib/stdlib/doc/src/epp.xml @@ -85,7 +85,7 @@ - + Return the default encoding of Erlang source files.

Returns the default encoding of Erlang source files.

@@ -93,7 +93,7 @@ - + Return a string representation of an encoding.

Returns a string representation of an encoding. The string @@ -107,7 +107,7 @@ - + Format an error descriptor.

Takes an ErrorDescriptor and returns @@ -120,7 +120,7 @@ - + Open a file for preprocessing.

Opens a file for preprocessing.

@@ -167,7 +167,7 @@ - + Preprocess and parse an Erlang source file.

Preprocesses and parses an Erlang source file. @@ -194,8 +194,8 @@ - - + + Read the encoding from a file.

Read the encoding from @@ -209,8 +209,8 @@ - - + + Read the encoding from a binary.

Read the encoding from @@ -224,7 +224,7 @@ - + Read and set the encoding of an I/O device.

Reads the encoding from @@ -239,7 +239,7 @@ - + Read and set the encoding of an I/O device.

Reads the encoding from diff --git a/lib/stdlib/doc/src/erl_anno.xml b/lib/stdlib/doc/src/erl_anno.xml index f316f63d98..dff93619ab 100644 --- a/lib/stdlib/doc/src/erl_anno.xml +++ b/lib/stdlib/doc/src/erl_anno.xml @@ -34,7 +34,7 @@ A erl_anno.xml - erl_anno + erl_anno Abstract datatype for the annotations of the Erlang Compiler. @@ -135,7 +135,7 @@ - + Return the column. @@ -144,7 +144,7 @@ - + Return the end location of the text. @@ -155,7 +155,7 @@ - + Return the filename. @@ -165,7 +165,7 @@ - + Return annotations given a term.

Returns annotations with representation Term.

@@ -174,7 +174,7 @@ - + Return the generated Boolean. @@ -185,7 +185,7 @@ - + Test for a collection of annotations.

Returns true if Term is a collection of @@ -194,7 +194,7 @@ - + Return the line. @@ -203,7 +203,7 @@ - + Return the location. @@ -212,7 +212,7 @@ - + Create a new collection of annotations. @@ -221,7 +221,7 @@ - + Modify the filename. @@ -230,7 +230,7 @@ - + Modify the generated marker. @@ -240,7 +240,7 @@ - + Modify the line. @@ -249,7 +249,7 @@ - + Modify the location. @@ -258,7 +258,7 @@ - + Modify the record marker. @@ -267,7 +267,7 @@ - + Modify the text. @@ -276,7 +276,7 @@ - + Return the text. @@ -286,7 +286,7 @@ - + Return the term representing a collection of annotations. diff --git a/lib/stdlib/doc/src/erl_internal.xml b/lib/stdlib/doc/src/erl_internal.xml index 17cd0fb240..45264e82a8 100644 --- a/lib/stdlib/doc/src/erl_internal.xml +++ b/lib/stdlib/doc/src/erl_internal.xml @@ -44,7 +44,7 @@ - + Add code for pre-defined functions.

Adds to Forms the code for the standard diff --git a/lib/stdlib/doc/src/erl_parse.xml b/lib/stdlib/doc/src/erl_parse.xml index 647f36883c..dd15d495a4 100644 --- a/lib/stdlib/doc/src/erl_parse.xml +++ b/lib/stdlib/doc/src/erl_parse.xml @@ -102,7 +102,7 @@ - + Convert an Erlang term into an abstract form. @@ -124,7 +124,7 @@ - + Return annotations as terms.

Assumes that Term is a term with the same @@ -140,7 +140,7 @@ - + Return the representation of annotations.

Returns a term where each collection of annotations @@ -154,7 +154,7 @@ - + Fold a function over the annotations of an erl_parse tree. @@ -188,7 +188,7 @@ - + Map a function over the annotations of an erl_parse tree. @@ -201,7 +201,7 @@ - + Map and fold a function over the annotations of an erl_parse tree. @@ -220,7 +220,7 @@ - + Create new annotations.

Assumes that Term is a term with the same diff --git a/lib/stdlib/doc/src/erl_scan.xml b/lib/stdlib/doc/src/erl_scan.xml index 137ccd3416..6507f23dab 100644 --- a/lib/stdlib/doc/src/erl_scan.xml +++ b/lib/stdlib/doc/src/erl_scan.xml @@ -74,7 +74,7 @@ - + Return the category.

Returns the category of Token.

@@ -82,7 +82,7 @@ - + Return the column.

Returns the column of Token's @@ -91,7 +91,7 @@ - + Return the end location of the text.

Returns the end location of the text of @@ -113,7 +113,7 @@ - + Return the line.

Returns the line of Token's collection @@ -122,7 +122,7 @@ - + Return the location.

Returns the location of Token's @@ -229,7 +229,7 @@ - + Return the symbol.

Returns the symbol of Token.

@@ -237,7 +237,7 @@ - + Return the text.

Returns the text of Token's collection diff --git a/lib/stdlib/doc/src/erl_tar.xml b/lib/stdlib/doc/src/erl_tar.xml index 68fa071090..0a0b5fa115 100644 --- a/lib/stdlib/doc/src/erl_tar.xml +++ b/lib/stdlib/doc/src/erl_tar.xml @@ -423,7 +423,7 @@ - init(UserPrivate, AccessMode, Fun) -> + init(UserPrivate, AccessMode, Fun) -> {ok,TarDescriptor} | {error,Reason} Create a TarDescriptor used in subsequent tar operations when defining own low-level storage access functions. diff --git a/lib/stdlib/doc/src/ets.xml b/lib/stdlib/doc/src/ets.xml index ad006f9a2b..98c5c39f2b 100644 --- a/lib/stdlib/doc/src/ets.xml +++ b/lib/stdlib/doc/src/ets.xml @@ -1510,7 +1510,7 @@ is_integer(X), is_integer(Y), X + Y < 4711]]> - + Match and replace objects atomically in an ETS table

Matches the objects in the table Tab using a @@ -1549,7 +1549,7 @@ Success = (1 =:= ets:select_replace(T, [{Old, [], [{const, New}]}])), - + Continue matching objects in an ETS table.

Continues a match started with @@ -1582,7 +1582,7 @@ Success = (1 =:= ets:select_replace(T, [{Old, [], [{const, New}]}])), - + Match the objects in an ETS table against a match specification. @@ -1594,7 +1594,7 @@ Success = (1 =:= ets:select_replace(T, [{Old, [], [{const, New}]}])), - + Match the objects in an ETS table against a match specification and return part of the answers. @@ -1869,7 +1869,7 @@ true - + Return and remove all objects with a specified key from an ETS table. @@ -1923,11 +1923,11 @@ true - + - + - + Update a counter object in an ETS table. @@ -2049,7 +2049,7 @@ true - + Retrieves the tid() of a named table.

This function returns the diff --git a/lib/stdlib/doc/src/filelib.xml b/lib/stdlib/doc/src/filelib.xml index 3b5be75bc0..790f289ae5 100644 --- a/lib/stdlib/doc/src/filelib.xml +++ b/lib/stdlib/doc/src/filelib.xml @@ -263,8 +263,8 @@ filelib:wildcard("lib/**/*.{erl,hrl}") - - + + Find a file relative to a given directory.

Looks for a file of the given name by applying suffix rules to @@ -278,7 +278,7 @@ filelib:wildcard("lib/**/*.{erl,hrl}") - + Find the source file for a given object file.

Equivalent to find_source(Base, Dir), where Dir is @@ -287,8 +287,8 @@ filelib:wildcard("lib/**/*.{erl,hrl}") - - + + Find a source file relative to a given directory.

Applies file extension specific rules to find the source file for diff --git a/lib/stdlib/doc/src/filename.xml b/lib/stdlib/doc/src/filename.xml index 36254c2d00..e4cca2074a 100644 --- a/lib/stdlib/doc/src/filename.xml +++ b/lib/stdlib/doc/src/filename.xml @@ -144,8 +144,8 @@ - - + + Equivalent to basedir(PathType, Application,#{}) or basedir(PathsType, Application,#{}). @@ -165,8 +165,8 @@ basedir(PathsType, Application, #{}). - - + + @@ -557,7 +557,7 @@ true - + Sanitize a relative path to avoid directory traversal attacks.

Sanitizes the relative path by eliminating ".." and "." diff --git a/lib/stdlib/doc/src/gb_sets.xml b/lib/stdlib/doc/src/gb_sets.xml index 03397b4503..16db0906f5 100644 --- a/lib/stdlib/doc/src/gb_sets.xml +++ b/lib/stdlib/doc/src/gb_sets.xml @@ -336,7 +336,7 @@ - + Return an iterator for a set starting from a specified element. diff --git a/lib/stdlib/doc/src/gb_trees.xml b/lib/stdlib/doc/src/gb_trees.xml index 5cfff021c1..3b55c2c75d 100644 --- a/lib/stdlib/doc/src/gb_trees.xml +++ b/lib/stdlib/doc/src/gb_trees.xml @@ -109,7 +109,7 @@ - + Returns a value and new tree without node with key Key.

Returns a value Value from node with key Key @@ -120,7 +120,7 @@ - + Returns a value and new tree without node with key Key.

Returns a value Value from node with key Key @@ -218,7 +218,7 @@ - + Return an iterator for a tree starting from a specified key. diff --git a/lib/stdlib/doc/src/gen_event.xml b/lib/stdlib/doc/src/gen_event.xml index fc34e51216..ff7da620c7 100644 --- a/lib/stdlib/doc/src/gen_event.xml +++ b/lib/stdlib/doc/src/gen_event.xml @@ -351,7 +351,7 @@ gen_event:stop -----> Module:terminate/2 start() -> Result start(EventMgrName | Options) -> Result - start(EventMgrName, Options) -> Result + start(EventMgrName, Options) -> Result Create a stand-alone event manager process. EventMgrName = {local,Name} | {global,GlobalName} | {via,Module,ViaName} @@ -377,7 +377,7 @@ gen_event:stop -----> Module:terminate/2 start_link() -> Result start_link(EventMgrName | Options) -> Result - start_link(EventMgrName, Options) -> Result + start_link(EventMgrName, Options) -> Result Create a generic event manager process in a supervision tree. @@ -437,7 +437,7 @@ gen_event:stop -----> Module:terminate/2 stop(EventMgrRef) -> ok - stop(EventMgrRef, Reason, Timeout) -> ok + stop(EventMgrRef, Reason, Timeout) -> ok Terminate a generic event manager. EventMgrRef = Name | {Name,Node} | {global,GlobalName} @@ -611,7 +611,7 @@ gen_event:stop -----> Module:terminate/2 - Module:format_status(Opt, [PDict, State]) -> Status + Module:format_status(Opt, [PDict, State]) -> Status Optional function for providing a term describing the current event handler state. diff --git a/lib/stdlib/doc/src/gen_server.xml b/lib/stdlib/doc/src/gen_server.xml index 106bda85f5..f3742fb8fb 100644 --- a/lib/stdlib/doc/src/gen_server.xml +++ b/lib/stdlib/doc/src/gen_server.xml @@ -466,8 +466,8 @@ gen_server:abcast -----> Module:handle_cast/2 - stop(ServerRef) -> ok - stop(ServerRef, Reason, Timeout) -> ok + stop(ServerRef) -> ok + stop(ServerRef, Reason, Timeout) -> ok Synchronously stop a generic server. ServerRef = Name | {Name,Node} | {global,GlobalName} @@ -550,7 +550,7 @@ gen_server:abcast -----> Module:handle_cast/2 - Module:format_status(Opt, [PDict, State]) -> Status + Module:format_status(Opt, [PDict, State]) -> Status Optional function for providing a term describing the current gen_server status. @@ -703,7 +703,7 @@ gen_server:abcast -----> Module:handle_cast/2 - Module:handle_continue(Continue, State) -> Result + Module:handle_continue(Continue, State) -> Result Handle a continue instruction. Continue = term() diff --git a/lib/stdlib/doc/src/gen_statem.xml b/lib/stdlib/doc/src/gen_statem.xml index a808d3af55..aaa26df18d 100644 --- a/lib/stdlib/doc/src/gen_statem.xml +++ b/lib/stdlib/doc/src/gen_statem.xml @@ -28,7 +28,7 @@ - gen_statem + gen_statem Generic state machine behavior.

@@ -1398,8 +1398,8 @@ handle_event(_, _, State, Data) -> - - + + Make a synchronous call to a gen_statem.

@@ -1474,7 +1474,7 @@ handle_event(_, _, State, Data) -> - + Send an asynchronous event to a gen_statem.

@@ -1493,7 +1493,7 @@ handle_event(_, _, State, Data) -> - + Enter the gen_statem receive loop.

@@ -1507,7 +1507,7 @@ handle_event(_, _, State, Data) -> - + Enter the gen_statem receive loop.

@@ -1531,7 +1531,7 @@ handle_event(_, _, State, Data) -> - + Enter the gen_statem receive loop.

@@ -1588,8 +1588,8 @@ handle_event(_, _, State, Data) -> - - + + Reply to a caller.

@@ -1621,8 +1621,8 @@ handle_event(_, _, State, Data) -> - - + + Create a standalone gen_statem process.

@@ -1642,8 +1642,8 @@ handle_event(_, _, State, Data) -> - - + + Create a linked gen_statem process.

@@ -1750,7 +1750,7 @@ handle_event(_, _, State, Data) -> - + Synchronously stop a generic server.

@@ -1761,7 +1761,7 @@ handle_event(_, _, State, Data) -> - + Synchronously stop a generic server.

@@ -1807,7 +1807,7 @@ handle_event(_, _, State, Data) -> - Module:callback_mode() -> CallbackMode + Module:callback_mode() -> CallbackMode Update the internal state during upgrade/downgrade. @@ -1858,7 +1858,7 @@ handle_event(_, _, State, Data) -> - Module:code_change(OldVsn, OldState, OldData, Extra) -> + Module:code_change(OldVsn, OldState, OldData, Extra) -> Result Update the internal state during upgrade/downgrade. @@ -1947,7 +1947,7 @@ handle_event(_, _, State, Data) -> - Module:init(Args) -> Result(StateType) + Module:init(Args) -> Result(StateType) Initializing process and internal state. @@ -1989,7 +1989,7 @@ init(Args) -> erlang:error(not_implemented, [Args]). - Module:format_status(Opt, [PDict,State,Data]) -> + Module:format_status(Opt, [PDict,State,Data]) -> Status Optional function for providing a term describing the @@ -2088,16 +2088,16 @@ init(Args) -> erlang:error(not_implemented, [Args]). - Module:StateName(enter, OldState, Data) -> + Module:StateName(enter, OldState, Data) -> StateEnterResult(StateName) - Module:StateName(EventType, EventContent, Data) -> + Module:StateName(EventType, EventContent, Data) -> StateFunctionResult - Module:handle_event(enter, OldState, State, Data) -> + Module:handle_event(enter, OldState, State, Data) -> StateEnterResult(State) - Module:handle_event(EventType, EventContent, State, Data) -> + Module:handle_event(EventType, EventContent, State, Data) -> HandleEventResult Handle an event. @@ -2216,7 +2216,7 @@ init(Args) -> erlang:error(not_implemented, [Args]). - Module:terminate(Reason, State, Data) -> Ignored + Module:terminate(Reason, State, Data) -> Ignored Clean up before termination. Reason = normal | shutdown | {shutdown,term()} | term() diff --git a/lib/stdlib/doc/src/io.xml b/lib/stdlib/doc/src/io.xml index d4a2713840..943b3479ca 100644 --- a/lib/stdlib/doc/src/io.xml +++ b/lib/stdlib/doc/src/io.xml @@ -794,7 +794,7 @@ enter>: alan : joe - + Read, tokenize, and parse Erlang expressions. @@ -847,7 +847,7 @@ enter>abc("hey". - + Read, tokenize, and parse an Erlang form. @@ -888,7 +888,7 @@ enter>abc("hey". - + Get user-requested printable character range.

Returns the user-requested range of printable Unicode characters.

@@ -961,7 +961,7 @@ enter>abc("hey". - + Read a term. @@ -1012,7 +1012,7 @@ enter>abc("hey". - + Read and tokenize Erlang expressions. @@ -1063,7 +1063,7 @@ enter>1.0er. - + Read and tokenize an Erlang form. diff --git a/lib/stdlib/doc/src/io_lib.xml b/lib/stdlib/doc/src/io_lib.xml index a3df2897ac..8a0b674126 100644 --- a/lib/stdlib/doc/src/io_lib.xml +++ b/lib/stdlib/doc/src/io_lib.xml @@ -99,7 +99,7 @@ - + Build the output text for a preparsed format list.

For details, see @@ -126,7 +126,7 @@ - + Test for a deep list of characters.

Returns true if Term is a, possibly deep, @@ -156,8 +156,8 @@ - - + + Write formatted output.

Returns a character list that represents Data @@ -277,7 +277,7 @@ - + Test for a list of ISO Latin-1 characters.

Returns true if Term is a flat list of @@ -315,7 +315,7 @@ - + Test for a list of printable ISO Latin-1 characters.

Returns true if Term is a flat list of @@ -338,7 +338,7 @@ - + Test for a list of printable Unicode characters.

Returns true if Term is a flat list of @@ -347,7 +347,7 @@ - + Parse all control sequences in the format string.

Returns a list corresponding to the specified format string, @@ -373,7 +373,7 @@ - + Revert a preparsed format list to a plain character list and a list of arguments. @@ -420,7 +420,7 @@ - + Write an atom.

Returns the list of characters needed to print atom @@ -439,7 +439,7 @@ - + Write a character.

Returns the list of characters needed to print a character @@ -449,7 +449,7 @@ - + Write an ISO Latin-1 character.

Returns the list of characters needed to print a character @@ -458,7 +458,7 @@ - + Write an ISO Latin-1 string.

Returns the list of characters needed to print @@ -476,7 +476,7 @@ - + Write a string.

Returns the list of characters needed to print diff --git a/lib/stdlib/doc/src/lists.xml b/lib/stdlib/doc/src/lists.xml index e4215a5336..f126326b09 100644 --- a/lib/stdlib/doc/src/lists.xml +++ b/lib/stdlib/doc/src/lists.xml @@ -137,7 +137,7 @@ - + Drop the last element of a list.

Drops the last element of a List. The list is to @@ -182,7 +182,7 @@ - + Filter and map elements that satisfy a function.

Calls Fun(Elem) on successive @@ -297,7 +297,7 @@ flatmap(Fun, List1) -> - + Insert an element between elements in a list

Inserts Sep between each element in List1. Has no @@ -771,7 +771,7 @@ length(lists:seq(From, To, Incr)) =:= (To - From + Incr) div Incr - + Find the first element that satisfies a predicate.

If there is a Value in List diff --git a/lib/stdlib/doc/src/maps.xml b/lib/stdlib/doc/src/maps.xml index a225dea3b5..acc4850bd9 100644 --- a/lib/stdlib/doc/src/maps.xml +++ b/lib/stdlib/doc/src/maps.xml @@ -27,7 +27,7 @@ 2014-02-28 A - maps + maps Maps processing functions.

This module contains functions for maps processing.

@@ -49,7 +49,7 @@ - + Select pairs that satisfy a predicate.

Returns a map Map for which predicate @@ -68,7 +68,7 @@ - +

Returns a tuple {ok, Value}, where Value @@ -87,7 +87,7 @@ - +

Calls F(K, V, AccIn) for every K to value @@ -111,7 +111,7 @@ - +

Takes a list of key-value tuples elements and builds a map. The @@ -128,7 +128,7 @@ - +

Returns value Value associated with @@ -147,7 +147,7 @@ - +

Returns value Value associated with @@ -168,7 +168,7 @@ val1 - +

Returns true if map Map contains @@ -188,7 +188,7 @@ false - + Create a map iterator.

Returns a map iterator Iterator that can @@ -214,7 +214,7 @@ none - +

Returns a complete list of keys, in any order, which resides @@ -230,7 +230,7 @@ none - +

Produces a new map Map by calling function @@ -253,7 +253,7 @@ none - +

Merges two maps into a single map Map3. If two @@ -271,7 +271,7 @@ none - +

Returns a new empty map.

@@ -283,7 +283,7 @@ none - + Get the next key and value from an iterator.

Returns the next key-value association in @@ -312,7 +312,7 @@ none - +

Associates Key with value @@ -336,7 +336,7 @@ none - +

Removes the Key, if it exists, and its @@ -356,7 +356,7 @@ none - +

Returns the number of key-value associations in @@ -370,7 +370,7 @@ none - +

The function removes the Key, if it @@ -395,7 +395,7 @@ error - +

Returns a list of pairs representing the key-value associations of @@ -412,7 +412,7 @@ error - +

If Key exists in Map1, the @@ -432,7 +432,7 @@ error - +

Update a value in a Map1 associated @@ -451,7 +451,7 @@ error - +

Update a value in a Map1 associated @@ -471,7 +471,7 @@ error - +

Returns a complete list of values, in arbitrary order, contained in @@ -487,7 +487,7 @@ error - +

Returns a new map Map2 with the keys K1 @@ -504,7 +504,7 @@ error - +

Returns a new map Map2 without keys K1 diff --git a/lib/stdlib/doc/src/math.xml b/lib/stdlib/doc/src/math.xml index b4f096217a..0672da88b9 100644 --- a/lib/stdlib/doc/src/math.xml +++ b/lib/stdlib/doc/src/math.xml @@ -57,15 +57,15 @@ - + - - + + - + diff --git a/lib/stdlib/doc/src/orddict.xml b/lib/stdlib/doc/src/orddict.xml index 26bbf499c6..e4dae4104d 100644 --- a/lib/stdlib/doc/src/orddict.xml +++ b/lib/stdlib/doc/src/orddict.xml @@ -113,7 +113,7 @@ - + Return value and new dictionary without element with this value.

This function returns value from dictionary and new dictionary without this value. @@ -166,7 +166,7 @@ - + Return true if the dictionary is empty.

Returns true if Orddict has no elements, diff --git a/lib/stdlib/doc/src/ordsets.xml b/lib/stdlib/doc/src/ordsets.xml index 11f98c8fb7..d1e24facef 100644 --- a/lib/stdlib/doc/src/ordsets.xml +++ b/lib/stdlib/doc/src/ordsets.xml @@ -142,7 +142,7 @@ - + Test for empty set.

Returns true if Ordset is an empty set, diff --git a/lib/stdlib/doc/src/proc_lib.xml b/lib/stdlib/doc/src/proc_lib.xml index b85fab67d5..8e7308ca74 100644 --- a/lib/stdlib/doc/src/proc_lib.xml +++ b/lib/stdlib/doc/src/proc_lib.xml @@ -111,7 +111,7 @@ - + Format a crash report. @@ -138,7 +138,7 @@ - + Format a crash report. @@ -341,7 +341,7 @@ init(Parent) -> - + Terminate a process synchronously. @@ -351,7 +351,7 @@ init(Parent) -> - + Terminate a process synchronously. diff --git a/lib/stdlib/doc/src/rand.xml b/lib/stdlib/doc/src/rand.xml index 21f680a0ee..27d2d99f3c 100644 --- a/lib/stdlib/doc/src/rand.xml +++ b/lib/stdlib/doc/src/rand.xml @@ -32,7 +32,7 @@ A rand.xml - rand + rand Pseudo random number generation.

@@ -273,7 +273,7 @@ tests. We suggest to use a sign test to extract a random Boolean value. - + Export the random number generation state.

Returns the random number state in an external format. @@ -282,7 +282,7 @@ tests. We suggest to use a sign test to extract a random Boolean value. - + Export the random number generation state.

Returns the random number generator state in an external format. @@ -291,7 +291,7 @@ tests. We suggest to use a sign test to extract a random Boolean value. - + Return the seed after performing jump calculation to the state in the process dictionary. @@ -306,7 +306,7 @@ tests. We suggest to use a sign test to extract a random Boolean value. - + Return the seed after performing jump calculation.

Returns the state after performing jump calculation @@ -318,7 +318,7 @@ tests. We suggest to use a sign test to extract a random Boolean value. - + Return a standard normal distributed random float.

Returns a standard normal deviate float (that is, the mean @@ -328,7 +328,7 @@ tests. We suggest to use a sign test to extract a random Boolean value. - + Return a normal distributed random float.

Returns a normal N(Mean, Variance) deviate float @@ -337,7 +337,7 @@ tests. We suggest to use a sign test to extract a random Boolean value. - + Return a standard normal distributed random float.

Returns, for a specified state, a standard normal @@ -347,7 +347,7 @@ tests. We suggest to use a sign test to extract a random Boolean value. - + Return a normal distributed random float.

Returns, for a specified state, a normal N(Mean, Variance) @@ -356,7 +356,7 @@ tests. We suggest to use a sign test to extract a random Boolean value. - + Seed random number generator. @@ -372,7 +372,7 @@ tests. We suggest to use a sign test to extract a random Boolean value. - + Seed the random number generation.

Seeds random number generation with the specified algorithm and @@ -381,7 +381,7 @@ tests. We suggest to use a sign test to extract a random Boolean value. - + Seed random number generator.

@@ -396,7 +396,7 @@ tests. We suggest to use a sign test to extract a random Boolean value. - + Seed the random number generation.

Seeds random number generation with the specified algorithm and @@ -405,7 +405,7 @@ tests. We suggest to use a sign test to extract a random Boolean value. - + Return a random float.

@@ -441,7 +441,7 @@ end. - + Return a random float.

@@ -477,7 +477,7 @@ end. - + Return a random integer.

Returns, for a specified integer N >= 1, @@ -488,7 +488,7 @@ end. - + Return a random float.

@@ -524,7 +524,7 @@ end. - + Return a random float.

@@ -586,7 +586,7 @@ end. - + Return a random integer.

Returns, for a specified integer N >= 1 diff --git a/lib/stdlib/doc/src/re.xml b/lib/stdlib/doc/src/re.xml index 078ca0e38c..71f49cb640 100644 --- a/lib/stdlib/doc/src/re.xml +++ b/lib/stdlib/doc/src/re.xml @@ -79,7 +79,7 @@ - + Gives the PCRE version of the system in a string format

The return of this function is a string with the PCRE version of the system that was used in the Erlang/OTP compilation.

@@ -304,7 +304,7 @@ - + Inspects a compiled regular expression.

Takes a compiled regular expression and an item, and returns the diff --git a/lib/stdlib/doc/src/sets.xml b/lib/stdlib/doc/src/sets.xml index 8db3e1e623..e076b9a5ec 100644 --- a/lib/stdlib/doc/src/sets.xml +++ b/lib/stdlib/doc/src/sets.xml @@ -140,7 +140,7 @@ - + Test for empty set.

Returns true if Set is an empty set, diff --git a/lib/stdlib/doc/src/shell.xml b/lib/stdlib/doc/src/shell.xml index 2593d3690b..892bb64daf 100644 --- a/lib/stdlib/doc/src/shell.xml +++ b/lib/stdlib/doc/src/shell.xml @@ -902,7 +902,7 @@ q - quit erlang - + Set the shell prompt.

Sets the shell prompt function to PromptFunc. @@ -945,7 +945,7 @@ q - quit erlang - + Set the shell's string recognition flag.

Sets pretty printing of lists to Strings. diff --git a/lib/stdlib/doc/src/string.xml b/lib/stdlib/doc/src/string.xml index 3348464eba..d3b0175d69 100644 --- a/lib/stdlib/doc/src/string.xml +++ b/lib/stdlib/doc/src/string.xml @@ -130,7 +130,7 @@ - + Convert a string to a comparable string.

@@ -147,7 +147,7 @@ - + Remove trailing end of line control characters.

@@ -165,8 +165,8 @@ - - + + Test string equality.

@@ -201,8 +201,8 @@ true - - + + Find start of substring.

@@ -230,7 +230,7 @@ nomatch - + Check if the string is empty.

Returns true if String is the @@ -245,7 +245,7 @@ true - + Calculate length of the string.

@@ -261,7 +261,7 @@ true - + Split string into lexemes.

@@ -287,7 +287,7 @@ true - + Convert a string to lowercase

@@ -306,7 +306,7 @@ true - + Pick the first codepoint.

@@ -323,7 +323,7 @@ true - + Pick the first grapheme cluster.

@@ -340,7 +340,7 @@ true - + Pick the nth lexeme.

Returns lexeme number N in @@ -355,9 +355,9 @@ true - - - + + + Pad a string to given length.

@@ -381,7 +381,7 @@ true - + Remove prefix from string.

@@ -400,8 +400,8 @@ nomatch - - + + Replace a pattern in string.

@@ -423,7 +423,7 @@ nomatch - + Reverses a string

@@ -439,8 +439,8 @@ ÖÄÅ - - + + Extract a part of string

Returns a substring of String of @@ -459,8 +459,8 @@ ÖÄÅ - - + + Split a string into substrings.

@@ -482,9 +482,9 @@ ÖÄÅ - - - + + + Take leading or trailing parts.

Takes characters from String as long as @@ -508,7 +508,7 @@ ÖÄÅ - + Convert a string to titlecase.

@@ -566,7 +566,7 @@ ÖÄÅ - + Convert a string to a list of grapheme clusters.

@@ -582,9 +582,9 @@ ÖÄÅ - - - + + + Trim leading or trailing, or both, characters.

@@ -616,7 +616,7 @@ ÖÄÅ - + Convert a string to uppercase.

diff --git a/lib/stdlib/doc/src/supervisor.xml b/lib/stdlib/doc/src/supervisor.xml index 5fd5760499..eb6168c002 100644 --- a/lib/stdlib/doc/src/supervisor.xml +++ b/lib/stdlib/doc/src/supervisor.xml @@ -329,7 +329,7 @@ child_spec() = #{id => child_id(), % mandatory - + Return counts for the number of child specifications, active children, supervisors, and workers. @@ -387,7 +387,7 @@ child_spec() = #{id => child_id(), % mandatory - + Return the child specification map for the specified child. diff --git a/lib/stdlib/doc/src/sys.xml b/lib/stdlib/doc/src/sys.xml index 9fe816e33a..040f6587ec 100644 --- a/lib/stdlib/doc/src/sys.xml +++ b/lib/stdlib/doc/src/sys.xml @@ -143,8 +143,8 @@ - - + + Get the state of the process.

Gets the state of the process.

@@ -338,8 +338,8 @@ - - + + Replace the state of the process.

Replaces the state of the process, and returns the new state.

@@ -482,8 +482,8 @@ - - + + Terminate the process.

Orders the process to terminate with the @@ -644,7 +644,7 @@ - Module:system_get_state(Misc) -> {ok, State} + Module:system_get_state(Misc) -> {ok, State} Called when the process is to return its current state. @@ -661,7 +661,7 @@ - Module:system_replace_state(StateFun, Misc) -> + Module:system_replace_state(StateFun, Misc) -> {ok, NState, NMisc} Called when the process is to replace its current state. diff --git a/lib/stdlib/doc/src/timer.xml b/lib/stdlib/doc/src/timer.xml index e913e33589..885bb89b1a 100644 --- a/lib/stdlib/doc/src/timer.xml +++ b/lib/stdlib/doc/src/timer.xml @@ -258,8 +258,8 @@ - - + + Measure the real time it takes to evaluate apply(Module, Function, Arguments) or apply(Fun, Arguments). diff --git a/lib/stdlib/doc/src/unicode.xml b/lib/stdlib/doc/src/unicode.xml index d822aca89c..2451006564 100644 --- a/lib/stdlib/doc/src/unicode.xml +++ b/lib/stdlib/doc/src/unicode.xml @@ -367,7 +367,7 @@ decode_data(Data) -> - + Normalize characters to a list of canonical equivalent composed Unicode characters. @@ -386,7 +386,7 @@ decode_data(Data) -> - + Normalize characters to a utf8 binary of canonical equivalent composed Unicode characters. @@ -404,7 +404,7 @@ decode_data(Data) -> - + Normalize characters to a list of canonical equivalent decomposed Unicode characters. @@ -423,7 +423,7 @@ decode_data(Data) -> - + Normalize characters to a utf8 binary of canonical equivalent decomposed Unicode characters. @@ -441,7 +441,7 @@ decode_data(Data) -> - + Normalize characters to a list of canonical equivalent composed Unicode characters. @@ -460,7 +460,7 @@ decode_data(Data) -> - + Normalize characters to a utf8 binary of compatibly equivalent composed Unicode characters. @@ -478,7 +478,7 @@ decode_data(Data) -> - + Normalize characters to a list of compatibly equivalent decomposed Unicode characters. @@ -497,7 +497,7 @@ decode_data(Data) -> - + Normalize characters to a utf8 binary of compatibly equivalent decomposed Unicode characters. diff --git a/lib/stdlib/doc/src/uri_string.xml b/lib/stdlib/doc/src/uri_string.xml index 88d4600611..ad443486c5 100644 --- a/lib/stdlib/doc/src/uri_string.xml +++ b/lib/stdlib/doc/src/uri_string.xml @@ -27,7 +27,7 @@ 2018-02-07 A - uri_string + uri_string URI processing functions.

This module contains functions for parsing and handling URIs @@ -150,7 +150,7 @@ - + Compose urlencoded query string.

Composes a form-urlencoded QueryString based on a @@ -176,7 +176,7 @@ - + Compose urlencoded query string.

Same as compose_query/1 but with an additional @@ -210,7 +210,7 @@ - + Dissect query string.

Dissects an urlencoded QueryString and returns a @@ -236,7 +236,7 @@ - + Syntax-based normalization.

Transforms an URI into a normalized form @@ -261,7 +261,7 @@ - + Syntax-based normalization.

Same as normalize/1 but with an additional @@ -285,7 +285,7 @@ - + Parse URI into a map.

Parses an RFC 3986 @@ -309,7 +309,7 @@ - + Recompose URI.

Creates an RFC 3986 compliant @@ -332,7 +332,7 @@ - + Transcode URI.

Transcodes an RFC 3986 diff --git a/lib/stdlib/doc/src/zip.xml b/lib/stdlib/doc/src/zip.xml index 0b5eac1e16..aaa25952c2 100644 --- a/lib/stdlib/doc/src/zip.xml +++ b/lib/stdlib/doc/src/zip.xml @@ -180,7 +180,7 @@ - + Fold a function over all files in a zip archive.

Calls Fun(FileInArchive, GetInfo -- cgit v1.2.3