Also:
* Always use `/* */` block comments
* Use the same message everywhere, rather than sometimes prefixing
with "some"
When I first read rustdoc docs, I was confused why the fields were being
omitted. It was only later that I realized it was because they were
private. It's also always bothered me that rustdoc sometimes uses `//`
and sometimes uses `/*` comments for these messages, so this change
makes them all use `/*`.
Technically, I think fields can be omitted if they are public but
`doc(hidden)` too, but `doc(hidden)` is analogous to privacy. It's
really just used to emulate "doc privacy" when -- because of technical
limitations -- an item has to be public. So I think it's fine to include
this under the category of "private fields".
9 lines
175 B
Rust
9 lines
175 B
Rust
// @has union/union.U.html
|
|
pub union U {
|
|
// @has - //pre "pub a: u8"
|
|
pub a: u8,
|
|
// @has - //pre "/* private fields */"
|
|
// @!has - //pre "b: u16"
|
|
b: u16,
|
|
}
|