invalid prototype for ei_get_type in documentation

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

invalid prototype for ei_get_type in documentation

Einar Karttunen
Hello

The C interface function ei_get_type has the type
int ei_get_type(const char *buf, const int *index, int *type, int *len)
as defined in erl_interface-3.3.2/src/get_type.c and
erl_interface-3.3.2/include/eicode.h. The documentation
however claims that it is:
int ei_get_type(const ei_x_buff* x, int *type, int *size)
which is quite clearly wrong.

This affects
erl_interface-3.3.2/doc/html/ei.html

Here is a useless diff since the source is probably managed in
a saner format...

diff -u html.ori/ei.html html/ei.html
--- html.ori/ei.html    2003-03-04 17:22:49.000000000 +0200
+++ html/ei.html        2003-05-09 19:21:48.000000000 +0300
@@ -233,7 +233,7 @@
 <P>      This function encodes an empty list. It's often used at the
          tail of a list.
 </UL>
-<P><A NAME="ei_get_type%3"><STRONG><CODE>int ei_get_type(const ei_x_buff* x, int *type, int *size)</CODE></STRONG></A><BR>
+<P><A NAME="ei_get_type%3"><STRONG><CODE>int ei_get_type(const char* buf, int *type, int *size)</CODE></STRONG></A><BR>
 <UL>
 <P>      This function returns the type in <CODE>type</CODE> and size in
          <CODE>size</CODE> of the encoded term. For strings and atoms, size


The same error is in the current web documentation (the corresponding file).

ps. please cc-me as I'm not subscribed to this list.

- Einar Karttunen