From 50f64c60b87e8d03fedc3f9f4e655aff8ca9f16c Mon Sep 17 00:00:00 2001 From: Sverker Eriksson Date: Wed, 12 Dec 2018 19:32:24 +0100 Subject: Add empty 'since' attribute for old modules and functions --- lib/erl_interface/doc/src/ei.xml | 160 +++++++++++++++++++-------------------- 1 file changed, 80 insertions(+), 80 deletions(-) (limited to 'lib/erl_interface/doc/src/ei.xml') diff --git a/lib/erl_interface/doc/src/ei.xml b/lib/erl_interface/doc/src/ei.xml index 2a17643270..16f4e18637 100644 --- a/lib/erl_interface/doc/src/ei.xml +++ b/lib/erl_interface/doc/src/ei.xml @@ -124,7 +124,7 @@ typedef enum { - intei_decode_atom(const char *buf, int *index, char *p) + intei_decode_atom(const char *buf, int *index, char *p) Decode an atom.

Decodes an atom from the binary format. The NULL-terminated @@ -158,7 +158,7 @@ typedef enum { - intei_decode_bignum(const char *buf, int *index, mpz_t obj) + intei_decode_bignum(const char *buf, int *index, mpz_t obj) Decode a GMP arbitrary precision integer.

Decodes an integer in the binary format to a GMP @@ -168,7 +168,7 @@ typedef enum { - intei_decode_binary(const char *buf, int *index, void *p, long *len) + intei_decode_binary(const char *buf, int *index, void *p, long *len) Decode a binary.

Decodes a binary from the binary format. Parameter @@ -180,7 +180,7 @@ typedef enum { - intei_decode_boolean(const char *buf, int *index, int *p) + intei_decode_boolean(const char *buf, int *index, int *p) Decode a boolean.

Decodes a boolean value from the binary format. @@ -190,7 +190,7 @@ typedef enum { - intei_decode_char(const char *buf, int *index, char *p) + intei_decode_char(const char *buf, int *index, char *p) Decode an 8-bit integer between 0-255.

Decodes a char (8-bit) integer between 0-255 from the binary format. @@ -203,7 +203,7 @@ typedef enum { - intei_decode_double(const char *buf, int *index, double *p) + intei_decode_double(const char *buf, int *index, double *p) Decode a double.

Decodes a double-precision (64-bit) floating @@ -212,7 +212,7 @@ typedef enum { - intei_decode_ei_term(const char* buf, int* index, ei_term* term) + intei_decode_ei_term(const char* buf, int* index, ei_term* term) Decode a term, without previous knowledge of type.

Decodes any term, or at least tries to. If the term @@ -233,8 +233,8 @@ typedef enum { - intei_decode_fun(const char *buf, int *index, erlang_fun *p) - voidfree_fun(erlang_fun* f) + intei_decode_fun(const char *buf, int *index, erlang_fun *p) + voidfree_fun(erlang_fun* f) Decode a fun.

Decodes a fun from the binary format. Parameter @@ -248,7 +248,7 @@ typedef enum { - intei_decode_list_header(const char *buf, int *index, int *arity) + intei_decode_list_header(const char *buf, int *index, int *arity) Decode a list.

Decodes a list header from the binary @@ -265,7 +265,7 @@ typedef enum { - intei_decode_long(const char *buf, int *index, long *p) + intei_decode_long(const char *buf, int *index, long *p) Decode integer.

Decodes a long integer from the binary format. @@ -275,7 +275,7 @@ typedef enum { - intei_decode_longlong(const char *buf, int *index, long long *p) + intei_decode_longlong(const char *buf, int *index, long long *p) Decode integer.

Decodes a GCC long long or Visual C++ @@ -299,7 +299,7 @@ typedef enum { - intei_decode_pid(const char *buf, int *index, erlang_pid *p) + intei_decode_pid(const char *buf, int *index, erlang_pid *p) Decode a pid.

Decodes a process identifier (pid) from the binary format.

@@ -307,7 +307,7 @@ typedef enum {
- intei_decode_port(const char *buf, int *index, erlang_port *p) + intei_decode_port(const char *buf, int *index, erlang_port *p) Decode a port.

Decodes a port identifier from the binary format.

@@ -315,7 +315,7 @@ typedef enum {
- intei_decode_ref(const char *buf, int *index, erlang_ref *p) + intei_decode_ref(const char *buf, int *index, erlang_ref *p) Decode a reference.

Decodes a reference from the binary format.

@@ -323,7 +323,7 @@ typedef enum {
- intei_decode_string(const char *buf, int *index, char *p) + intei_decode_string(const char *buf, int *index, char *p) Decode a string.

Decodes a string from the binary format. A @@ -338,7 +338,7 @@ typedef enum { - intei_decode_term(const char *buf, int *index, void *t) + intei_decode_term(const char *buf, int *index, void *t) Decode a ETERM.

Decodes a term from the binary format. The term @@ -352,7 +352,7 @@ typedef enum { - intei_decode_trace(const char *buf, int *index, erlang_trace *p) + intei_decode_trace(const char *buf, int *index, erlang_trace *p) Decode a trace token.

Decodes an Erlang trace token from the binary format.

@@ -360,7 +360,7 @@ typedef enum {
- intei_decode_tuple_header(const char *buf, int *index, int *arity) + intei_decode_tuple_header(const char *buf, int *index, int *arity) Decode a tuple.

Decodes a tuple header, the number of elements @@ -370,7 +370,7 @@ typedef enum { - intei_decode_ulong(const char *buf, int *index, unsigned long *p) + intei_decode_ulong(const char *buf, int *index, unsigned long *p) Decode unsigned integer.

Decodes an unsigned long integer from the binary format. @@ -380,7 +380,7 @@ typedef enum { - intei_decode_ulonglong(const char *buf, int *index, unsigned long long *p) + intei_decode_ulonglong(const char *buf, int *index, unsigned long long *p) Decode unsigned integer.

Decodes a GCC unsigned long long or Visual C++ @@ -390,7 +390,7 @@ typedef enum { - intei_decode_version(const char *buf, int *index, int *version) + intei_decode_version(const char *buf, int *index, int *version) Decode an empty list (nil).

Decodes the version magic number for the @@ -400,10 +400,10 @@ typedef enum { - intei_encode_atom(char *buf, int *index, const char *p) - intei_encode_atom_len(char *buf, int *index, const char *p, int len) - intei_x_encode_atom(ei_x_buff* x, const char *p) - intei_x_encode_atom_len(ei_x_buff* x, const char *p, int len) + intei_encode_atom(char *buf, int *index, const char *p) + intei_encode_atom_len(char *buf, int *index, const char *p, int len) + intei_x_encode_atom(ei_x_buff* x, const char *p) + intei_x_encode_atom_len(ei_x_buff* x, const char *p, int len) Encode an atom.

Encodes an atom in the binary format. Parameter p @@ -435,8 +435,8 @@ typedef enum { - intei_encode_bignum(char *buf, int *index, mpz_t obj) - intei_x_encode_bignum(ei_x_buff *x, mpz_t obj) + intei_encode_bignum(char *buf, int *index, mpz_t obj) + intei_x_encode_bignum(ei_x_buff *x, mpz_t obj) Encode an arbitrary precision integer.

Encodes a GMP mpz_t integer to binary format. @@ -446,8 +446,8 @@ typedef enum { - intei_encode_binary(char *buf, int *index, const void *p, long len) - intei_x_encode_binary(ei_x_buff* x, const void *p, long len) + intei_encode_binary(char *buf, int *index, const void *p, long len) + intei_x_encode_binary(ei_x_buff* x, const void *p, long len) Encode a binary.

Encodes a binary in the binary format. The data is at @@ -456,8 +456,8 @@ typedef enum { - intei_encode_boolean(char *buf, int *index, int p) - intei_x_encode_boolean(ei_x_buff* x, int p) + intei_encode_boolean(char *buf, int *index, int p) + intei_x_encode_boolean(ei_x_buff* x, int p) Encode a boolean.

Encodes a boolean value as the atom true if @@ -467,8 +467,8 @@ typedef enum { - intei_encode_char(char *buf, int *index, char p) - intei_x_encode_char(ei_x_buff* x, char p) + intei_encode_char(char *buf, int *index, char p) + intei_x_encode_char(ei_x_buff* x, char p) Encode an 8-bit integer between 0-255.

Encodes a char (8-bit) as an integer between 0-255 in the binary @@ -481,8 +481,8 @@ typedef enum { - intei_encode_double(char *buf, int *index, double p) - intei_x_encode_double(ei_x_buff* x, double p) + intei_encode_double(char *buf, int *index, double p) + intei_x_encode_double(ei_x_buff* x, double p) Encode a double float.

Encodes a double-precision (64-bit) floating point number in @@ -493,8 +493,8 @@ typedef enum { - intei_encode_empty_list(char* buf, int* index) - intei_x_encode_empty_list(ei_x_buff* x) + intei_encode_empty_list(char* buf, int* index) + intei_x_encode_empty_list(ei_x_buff* x) Encode an empty list (nil).

Encodes an empty list. It is often used at the tail of a list.

@@ -502,8 +502,8 @@ typedef enum {
- intei_encode_fun(char *buf, int *index, const erlang_fun *p) - intei_x_encode_fun(ei_x_buff* x, const erlang_fun* fun) + intei_encode_fun(char *buf, int *index, const erlang_fun *p) + intei_x_encode_fun(ei_x_buff* x, const erlang_fun* fun) Encode a fun.

Encodes a fun in the binary format. Parameter p @@ -515,8 +515,8 @@ typedef enum { - intei_encode_list_header(char *buf, int *index, int arity) - intei_x_encode_list_header(ei_x_buff* x, int arity) + intei_encode_list_header(char *buf, int *index, int arity) + intei_x_encode_list_header(ei_x_buff* x, int arity) Encode a list.

Encodes a list header, with a specified @@ -552,8 +552,8 @@ ei_x_encode_empty_list(&x); - intei_encode_long(char *buf, int *index, long p) - intei_x_encode_long(ei_x_buff* x, long p) + intei_encode_long(char *buf, int *index, long p) + intei_x_encode_long(ei_x_buff* x, long p) Encode integer.

Encodes a long integer in the binary format. @@ -563,8 +563,8 @@ ei_x_encode_empty_list(&x); - intei_encode_longlong(char *buf, int *index, long long p) - intei_x_encode_longlong(ei_x_buff* x, long long p) + intei_encode_longlong(char *buf, int *index, long long p) + intei_x_encode_longlong(ei_x_buff* x, long long p) Encode integer.

Encodes a GCC long long or Visual C++ @@ -595,8 +595,8 @@ ei_x_encode_string(&x, "Banana"); - intei_encode_pid(char *buf, int *index, const erlang_pid *p) - intei_x_encode_pid(ei_x_buff* x, const erlang_pid *p) + intei_encode_pid(char *buf, int *index, const erlang_pid *p) + intei_x_encode_pid(ei_x_buff* x, const erlang_pid *p) Encode a pid.

Encodes an Erlang process identifier (pid) in the binary @@ -607,8 +607,8 @@ ei_x_encode_string(&x, "Banana"); - intei_encode_port(char *buf, int *index, const erlang_port *p) - intei_x_encode_port(ei_x_buff* x, const erlang_port *p) + intei_encode_port(char *buf, int *index, const erlang_port *p) + intei_x_encode_port(ei_x_buff* x, const erlang_port *p) Encode a port.

Encodes an Erlang port in the binary format. Parameter @@ -619,8 +619,8 @@ ei_x_encode_string(&x, "Banana"); - intei_encode_ref(char *buf, int *index, const erlang_ref *p) - intei_x_encode_ref(ei_x_buff* x, const erlang_ref *p) + intei_encode_ref(char *buf, int *index, const erlang_ref *p) + intei_x_encode_ref(ei_x_buff* x, const erlang_ref *p) Encode a ref.

Encodes an Erlang reference in the binary format. Parameter @@ -631,10 +631,10 @@ ei_x_encode_string(&x, "Banana"); - intei_encode_string(char *buf, int *index, const char *p) - intei_encode_string_len(char *buf, int *index, const char *p, int len) - intei_x_encode_string(ei_x_buff* x, const char *p) - intei_x_encode_string_len(ei_x_buff* x, const char* s, int len) + intei_encode_string(char *buf, int *index, const char *p) + intei_encode_string_len(char *buf, int *index, const char *p, int len) + intei_x_encode_string(ei_x_buff* x, const char *p) + intei_x_encode_string_len(ei_x_buff* x, const char* s, int len) Encode a string.

Encodes a string in the binary format. (A string in Erlang @@ -645,8 +645,8 @@ ei_x_encode_string(&x, "Banana"); - intei_encode_term(char *buf, int *index, void *t) - intei_x_encode_term(ei_x_buff* x, void *t) + intei_encode_term(char *buf, int *index, void *t) + intei_x_encode_term(ei_x_buff* x, void *t) Encode an erl_interface term.

Encodes an ETERM, as obtained from @@ -656,8 +656,8 @@ ei_x_encode_string(&x, "Banana"); - intei_encode_trace(char *buf, int *index, const erlang_trace *p) - intei_x_encode_trace(ei_x_buff* x, const erlang_trace *p) + intei_encode_trace(char *buf, int *index, const erlang_trace *p) + intei_x_encode_trace(ei_x_buff* x, const erlang_trace *p) Encode a trace token.

Encodes an Erlang trace token in the binary format. @@ -668,8 +668,8 @@ ei_x_encode_string(&x, "Banana"); - intei_encode_tuple_header(char *buf, int *index, int arity) - intei_x_encode_tuple_header(ei_x_buff* x, int arity) + intei_encode_tuple_header(char *buf, int *index, int arity) + intei_x_encode_tuple_header(ei_x_buff* x, int arity) Encode a tuple.

Encodes a tuple header, with a specified @@ -687,8 +687,8 @@ ei_encode_tuple_header(buf, &i, 0); - intei_encode_ulong(char *buf, int *index, unsigned long p) - intei_x_encode_ulong(ei_x_buff* x, unsigned long p) + intei_encode_ulong(char *buf, int *index, unsigned long p) + intei_x_encode_ulong(ei_x_buff* x, unsigned long p) Encode unsigned integer.

Encodes an unsigned long integer in the binary format. @@ -698,8 +698,8 @@ ei_encode_tuple_header(buf, &i, 0); - intei_encode_ulonglong(char *buf, int *index, unsigned long long p) - intei_x_encode_ulonglong(ei_x_buff* x, unsigned long long p) + intei_encode_ulonglong(char *buf, int *index, unsigned long long p) + intei_x_encode_ulonglong(ei_x_buff* x, unsigned long long p) Encode unsigned integer.

Encodes a GCC unsigned long long or Visual C++ @@ -709,8 +709,8 @@ ei_encode_tuple_header(buf, &i, 0); - intei_encode_version(char *buf, int *index) - intei_x_encode_version(ei_x_buff* x) + intei_encode_version(char *buf, int *index) + intei_x_encode_version(ei_x_buff* x) Encode version.

Encodes a version magic number for the binary format. Must @@ -719,7 +719,7 @@ ei_encode_tuple_header(buf, &i, 0); - intei_get_type(const char *buf, const int *index, int *type, int *size) + intei_get_type(const char *buf, const int *index, int *type, int *size) Fetch the type and size of an encoded term.

Returns the type in type and size in @@ -733,8 +733,8 @@ ei_encode_tuple_header(buf, &i, 0); - intei_print_term(FILE* fp, const char* buf, int* index) - intei_s_print_term(char** s, const char* buf, int* index) + intei_print_term(FILE* fp, const char* buf, int* index) + intei_s_print_term(char** s, const char* buf, int* index) Print a term in clear text.

Prints a term, in clear text, to the file @@ -759,7 +759,7 @@ ei_encode_tuple_header(buf, &i, 0); - voidei_set_compat_rel(release_number) + voidei_set_compat_rel(release_number) Set the ei library in compatibility mode. unsigned release_number; @@ -794,7 +794,7 @@ ei_encode_tuple_header(buf, &i, 0); - intei_skip_term(const char* buf, int* index) + intei_skip_term(const char* buf, int* index) Skip a term.

Skips a term in the specified buffer; @@ -815,8 +815,8 @@ ei_encode_tuple_header(buf, &i, 0); - intei_x_append(ei_x_buff* x, const ei_x_buff* x2) - intei_x_append_buf(ei_x_buff* x, const char* buf, int len) + intei_x_append(ei_x_buff* x, const ei_x_buff* x2) + intei_x_append_buf(ei_x_buff* x, const char* buf, int len) Append a buffer at the end.

Appends data at the end of buffer x.

@@ -824,8 +824,8 @@ ei_encode_tuple_header(buf, &i, 0);
- intei_x_format(ei_x_buff* x, const char* fmt, ...) - intei_x_format_wo_ver(ei_x_buff* x, const char *fmt, ... ) + intei_x_format(ei_x_buff* x, const char* fmt, ...) + intei_x_format_wo_ver(ei_x_buff* x, const char *fmt, ... ) Format a term from a format string and parameters.

Formats a term, given as a string, to a buffer. @@ -853,7 +853,7 @@ encodes the tuple {numbers,12,3.14159} - intei_x_free(ei_x_buff* x) + intei_x_free(ei_x_buff* x) Free a buffer.

Frees an ei_x_buff buffer. @@ -862,8 +862,8 @@ encodes the tuple {numbers,12,3.14159} - intei_x_new(ei_x_buff* x) - intei_x_new_with_version(ei_x_buff* x) + intei_x_new(ei_x_buff* x) + intei_x_new_with_version(ei_x_buff* x) Allocate a new buffer.

Allocates a new ei_x_buff buffer. The -- cgit v1.2.3