From 41672f4fc0e1ce89cb6d04c435f21e0d1fbdb4d4 Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Thu, 28 Mar 2019 14:12:31 +0100 Subject: compiler: Fix documentation of cerl:c_binary/1 --- lib/compiler/src/cerl.erl | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/lib/compiler/src/cerl.erl b/lib/compiler/src/cerl.erl index fce23bfd68..62cd5b5120 100644 --- a/lib/compiler/src/cerl.erl +++ b/lib/compiler/src/cerl.erl @@ -2157,12 +2157,16 @@ values_arity(Node) -> %% @spec c_binary(Segments::[cerl()]) -> cerl() %% -%% @doc Creates an abstract binary-template. A binary object is a -%% sequence of 8-bit bytes. It is specified by zero or more bit-string -%% template segments of arbitrary lengths (in number of bits), -%% such that the sum of the lengths is evenly divisible by 8. If -%% Segments is [S1, ..., Sn], the result -%% represents "#{S1, ..., Sn}#". All the + +%% @doc Creates an abstract binary-template. A binary object is in +%% this context a sequence of an arbitrary number of bits. (The number +%% of bits used to be evenly divisible by 8, but after the +%% introduction of bit strings in the Erlang language, the choice was +%% made to use the binary template for all bit strings.) It is +%% specified by zero or more bit-string template segments of +%% arbitrary lengths (in number of bits). If Segments is +%% [S1, ..., Sn], the result represents +%% "#{S1, ..., Sn}#". All the %% Si must have type bitstr. %% %% @see ann_c_binary/2 -- cgit v1.2.3