mirror of
https://github.com/ruby/ruby.git
synced 2022-11-09 12:17:21 -05:00
improve doc coverage [ci skip]
Just split the comment for struct's one and array's one.
This commit is contained in:
parent
a0029ae2b6
commit
7d4c59203f
1 changed files with 9 additions and 7 deletions
|
@ -276,14 +276,9 @@ struct RString {
|
||||||
VALUE shared;
|
VALUE shared;
|
||||||
} aux;
|
} aux;
|
||||||
} heap;
|
} heap;
|
||||||
|
|
||||||
|
/** Embedded contents. */
|
||||||
struct {
|
struct {
|
||||||
/**
|
|
||||||
* Embedded contents. When a string is short enough, it uses this area
|
|
||||||
* to store the contents themselves. This was impractical in the 20th
|
|
||||||
* century, but these days 64 bit machines can typically hold 24 bytes
|
|
||||||
* here. Could be sufficiently large. In this case the length is
|
|
||||||
* encoded into the flags.
|
|
||||||
*/
|
|
||||||
#if USE_RVARGC
|
#if USE_RVARGC
|
||||||
short len;
|
short len;
|
||||||
/* This is a length 1 array because:
|
/* This is a length 1 array because:
|
||||||
|
@ -293,6 +288,13 @@ struct RString {
|
||||||
*/
|
*/
|
||||||
char ary[1];
|
char ary[1];
|
||||||
#else
|
#else
|
||||||
|
/**
|
||||||
|
* When a string is short enough, it uses this area to store the
|
||||||
|
* contents themselves. This was impractical in the 20th century,
|
||||||
|
* but these days 64 bit machines can typically hold 24 bytes here.
|
||||||
|
* Could be sufficiently large. In this case the length is encoded
|
||||||
|
* into the flags.
|
||||||
|
*/
|
||||||
char ary[RSTRING_EMBED_LEN_MAX + 1];
|
char ary[RSTRING_EMBED_LEN_MAX + 1];
|
||||||
#endif
|
#endif
|
||||||
} embed;
|
} embed;
|
||||||
|
|
Loading…
Add table
Reference in a new issue