2b70a3df7a
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".
44 lines
975 B
Rust
44 lines
975 B
Rust
// @has structfields/struct.Foo.html
|
|
pub struct Foo {
|
|
// @has - //pre "pub a: ()"
|
|
pub a: (),
|
|
// @has - //pre "/* private fields */"
|
|
// @!has - //pre "b: ()"
|
|
b: (),
|
|
// @!has - //pre "c: usize"
|
|
#[doc(hidden)]
|
|
c: usize,
|
|
// @has - //pre "pub d: usize"
|
|
pub d: usize,
|
|
}
|
|
|
|
// @has structfields/struct.Bar.html
|
|
pub struct Bar {
|
|
// @has - //pre "pub a: ()"
|
|
pub a: (),
|
|
// @!has - //pre "/* private fields */"
|
|
}
|
|
|
|
// @has structfields/enum.Qux.html
|
|
pub enum Qux {
|
|
Quz {
|
|
// @has - //pre "a: ()"
|
|
a: (),
|
|
// @!has - //pre "b: ()"
|
|
#[doc(hidden)]
|
|
b: (),
|
|
// @has - //pre "c: usize"
|
|
c: usize,
|
|
// @has - //pre "/* private fields */"
|
|
},
|
|
}
|
|
|
|
// @has structfields/struct.Baz.html //pre "pub struct Baz { /* private fields */ }"
|
|
pub struct Baz {
|
|
x: u8,
|
|
#[doc(hidden)]
|
|
pub y: u8,
|
|
}
|
|
|
|
// @has structfields/struct.Quux.html //pre "pub struct Quux {}"
|
|
pub struct Quux {}
|