From 97ff595e4e0303f597e671b17045940ba8da0330 Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Tue, 13 Oct 2015 14:03:03 +0200 Subject: [erl_interface] Correct documentation Fix mistakes found by 'xmllint'. --- lib/erl_interface/doc/src/ei.xml | 8 ++++---- lib/erl_interface/doc/src/erl_call.xml | 4 ++-- lib/erl_interface/doc/src/erl_eterm.xml | 4 ++++ 3 files changed, 10 insertions(+), 6 deletions(-) (limited to 'lib') diff --git a/lib/erl_interface/doc/src/ei.xml b/lib/erl_interface/doc/src/ei.xml index 6044ac8ef7..8ef433d10f 100644 --- a/lib/erl_interface/doc/src/ei.xml +++ b/lib/erl_interface/doc/src/ei.xml @@ -264,9 +264,9 @@ typedef enum { Encode an atom

Encodes an atom in the binary format with character encoding - to_enc (latin1 or utf8). + to_enc (latin1 or utf8). The p parameter is the name of the atom with character encoding - from_enc (ascii, latin1 or utf8). + from_enc (ascii, latin1 or utf8). The name must either be zero-terminated or a function variant with a len parameter must be used. If to_enc is set to the bitwise-or'd combination (ERLANG_LATIN1|ERLANG_UTF8), utf8 encoding is only used if the atom string @@ -569,8 +569,8 @@ ei_x_encode_string(&x, "Banana");

This function decodes an atom from the binary format. The null terminated name of the atom is placed in buffer at p of length plen bytes.

-

The wanted string encoding is specified by - want. The original encoding used in the +

The wanted string encoding is specified by + want. The original encoding used in the binary format (latin1 or utf8) can be obtained from *was. The actual encoding of the resulting string (7-bit ascii, latin1 or utf8) can be obtained from *result. Both was and result can be NULL. diff --git a/lib/erl_interface/doc/src/erl_call.xml b/lib/erl_interface/doc/src/erl_call.xml index aed1ba0ac9..e982bf89e1 100644 --- a/lib/erl_interface/doc/src/erl_call.xml +++ b/lib/erl_interface/doc/src/erl_call.xml @@ -178,7 +178,7 @@ erl_call -s -a 'erlang halt' -n madonna -

Evaluates a couple of expressions. The input ends with EOF (Control-D).

+

Evaluates a couple of expressions. The input ends with EOF (Control-D).

-

Compiles a module and runs it. Again, the input ends with EOF (Control-D). (In the example shown, the output has been formatted afterwards).

+

Compiles a module and runs it. Again, the input ends with EOF (Control-D). (In the example shown, the output has been formatted afterwards).

+ A string representing atom . + The length (in bytes) of atom t. @@ -95,6 +97,7 @@ The floating point value of . + The Node in pid . @@ -108,6 +111,7 @@ The creation number in port . + The node in port . -- cgit v1.2.3