diff options
Diffstat (limited to 'lib/stdlib/doc/src/lib.xml')
| -rw-r--r-- | lib/stdlib/doc/src/lib.xml | 80 |
1 files changed, 43 insertions, 37 deletions
diff --git a/lib/stdlib/doc/src/lib.xml b/lib/stdlib/doc/src/lib.xml index 30f164826c..58dad7c9e0 100644 --- a/lib/stdlib/doc/src/lib.xml +++ b/lib/stdlib/doc/src/lib.xml @@ -4,20 +4,21 @@ <erlref> <header> <copyright> - <year>1996</year><year>2013</year> + <year>1996</year><year>2016</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> - The contents of this file are subject to the Erlang Public License, - Version 1.1, (the "License"); you may not use this file except in - compliance with the License. You should have received a copy of the - Erlang Public License along with this software. If not, it can be - retrieved online at http://www.erlang.org/. - - Software distributed under the License is distributed on an "AS IS" - basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See - the License for the specific language governing rights and limitations - under the License. + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. </legalnotice> @@ -28,68 +29,73 @@ <rev></rev> </header> <module>lib</module> - <modulesummary>A number of useful library functions</modulesummary> + <modulesummary>Useful library functions.</modulesummary> <description> <warning> - <p>This module is retained for compatibility. It may disappear - without warning in a future release.</p> + <p>This module is retained for backward compatibility. It can disappear + without warning in a future Erlang/OTP release.</p> </warning> </description> + <funcs> <func> - <name name="flush_receive" arity="0"/> - <fsummary>Flush messages</fsummary> - <desc> - <p>Flushes the message buffer of the current process.</p> - </desc> - </func> - <func> <name name="error_message" arity="2"/> - <fsummary>Print error message</fsummary> + <fsummary>Print error message.</fsummary> <desc> <p>Prints error message <c><anno>Args</anno></c> in accordance with - <c><anno>Format</anno></c>. Similar to <c>io:format/2</c>, see - <seealso marker="io#fwrite/1">io(3)</seealso>.</p> + <c><anno>Format</anno></c>. Similar to + <seealso marker="io#format/1"><c>io:format/2</c></seealso>.</p> </desc> </func> + <func> - <name name="progname" arity="0"/> - <fsummary>Return name of Erlang start script</fsummary> + <name name="flush_receive" arity="0"/> + <fsummary>Flush messages.</fsummary> <desc> - <p>Returns the name of the script that started the current - Erlang session.</p> + <p>Flushes the message buffer of the current process.</p> </desc> </func> + <func> <name name="nonl" arity="1"/> - <fsummary>Remove last newline</fsummary> + <fsummary>Remove last newline.</fsummary> <desc> <p>Removes the last newline character, if any, in <c><anno>String1</anno></c>.</p> </desc> </func> + + <func> + <name name="progname" arity="0"/> + <fsummary>Return name of Erlang start script.</fsummary> + <desc> + <p>Returns the name of the script that started the current + Erlang session.</p> + </desc> + </func> + <func> <name name="send" arity="2"/> - <fsummary>Send a message</fsummary> + <fsummary>Send a message.</fsummary> <desc> - <p>This function to makes it possible to send a message using - the <c>apply/3</c> BIF.</p> + <p>Makes it possible to send a message using the <c>apply/3</c> BIF.</p> </desc> </func> + <func> <name name="sendw" arity="2"/> - <fsummary>Send a message and wait for an answer</fsummary> + <fsummary>Send a message and wait for an answer.</fsummary> <desc> - <p>As <c>send/2</c>, but waits for an answer. It is implemented - as follows:</p> + <p>As <seealso marker="#send/2"><c>send/2</c></seealso>, + but waits for an answer. It is implemented as follows:</p> <code type="none"> sendw(To, Msg) -> To ! {self(),Msg}, receive Reply -> Reply end.</code> - <p>The message returned is not necessarily a reply to the - message sent.</p> + <p>The returned message is not necessarily a reply to the sent + message.</p> </desc> </func> </funcs> |