From 9f5b69e8def226f1d1ce9262477d5bbd1cbc1fe7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn-Egil=20Dahlberg?= Date: Mon, 17 Oct 2016 15:07:55 +0200 Subject: erl_interface: Refactor documentation --- lib/erl_interface/doc/src/erl_error.xml | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) (limited to 'lib/erl_interface/doc/src/erl_error.xml') diff --git a/lib/erl_interface/doc/src/erl_error.xml b/lib/erl_interface/doc/src/erl_error.xml index abe84780e1..5b8d546e12 100644 --- a/lib/erl_interface/doc/src/erl_error.xml +++ b/lib/erl_interface/doc/src/erl_error.xml @@ -11,7 +11,7 @@ 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 @@ -19,7 +19,7 @@ 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. - + erl_error @@ -30,13 +30,13 @@ Torbjörn Törnkvist 961014 A - erl_error.sgml + erl_error.xml erl_error Error Print Routines

This module contains some error printing routines taken - from Advanced Programming in the UNIX Environment + from Advanced Programming in the UNIX Environment by W. Richard Stevens.

These functions are all called in the same manner as , i.e. with a string containing format specifiers @@ -46,7 +46,7 @@ voiderl_err_msg(FormatStr, ... ) - Non-fatal error, and not system call error + Non-fatal error, and not system call error. const char *FormatStr; @@ -57,7 +57,7 @@ voiderl_err_quit(FormatStr, ... ) - Fatal error, but not system call error + Fatal error, but not system call error. const char *FormatStr; @@ -70,19 +70,19 @@ voiderl_err_ret(FormatStr, ... ) - Non-fatal system call error + Non-fatal system call error. const char *FormatStr;

Use this function after a failed system call. The message provided by the caller is printed followed by a string - describing the reason for failure.

+ describing the reason for failure.

voiderl_err_sys(FormatStr, ... ) - Fatal system call error + Fatal system call error. const char *FormatStr; @@ -107,7 +107,7 @@ volatile interl_errno - The variable contains the erl_interface error number. You can change the value if you wish. + The variable contains the erl_interface error number. You can change the value if you wish.

is initially (at program startup) zero and is then set by many erl_interface functions on failure to a @@ -134,4 +134,3 @@ - -- cgit v1.2.3