diff options
author | Hans Bolinder <[email protected]> | 2019-03-28 14:12:31 +0100 |
---|---|---|
committer | Hans Bolinder <[email protected]> | 2019-03-28 14:12:31 +0100 |
commit | 41672f4fc0e1ce89cb6d04c435f21e0d1fbdb4d4 (patch) | |
tree | 96c383d2a9994e26b2c78eb9b0e07e1731cdf18c /lib | |
parent | 2f879097241d289e0100c7d1725485e2276a7f70 (diff) | |
download | otp-41672f4fc0e1ce89cb6d04c435f21e0d1fbdb4d4.tar.gz otp-41672f4fc0e1ce89cb6d04c435f21e0d1fbdb4d4.tar.bz2 otp-41672f4fc0e1ce89cb6d04c435f21e0d1fbdb4d4.zip |
compiler: Fix documentation of cerl:c_binary/1
Diffstat (limited to 'lib')
-rw-r--r-- | lib/compiler/src/cerl.erl | 16 |
1 files 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 <em>segments</em> of arbitrary lengths (in number of bits), -%% such that the sum of the lengths is evenly divisible by 8. If -%% <code>Segments</code> is <code>[S1, ..., Sn]</code>, the result -%% represents "<code>#{<em>S1</em>, ..., <em>Sn</em>}#</code>". 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 <em>segments</em> of +%% arbitrary lengths (in number of bits). If <code>Segments</code> is +%% <code>[S1, ..., Sn]</code>, the result represents +%% "<code>#{<em>S1</em>, ..., <em>Sn</em>}#</code>". All the %% <code>Si</code> must have type <code>bitstr</code>. %% %% @see ann_c_binary/2 |