Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Hide private definitions in rustdoc #3538

Closed
brson opened this issue Sep 19, 2012 · 3 comments
Closed

Hide private definitions in rustdoc #3538

brson opened this issue Sep 19, 2012 · 3 comments
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Milestone

Comments

@brson
Copy link
Contributor

brson commented Sep 19, 2012

Rustdoc used to be able to do this, but forgot. Now there are a number of #[doc(hidden)] attributes floating around to make up for the deficiency.

@z0w0
Copy link
Contributor

z0w0 commented Mar 14, 2013

I'm surprised this wasn't fixed earlier, it's as simple as uncommenting a line of code.

@thestinger
Copy link
Contributor

Fixed by 387aa36.

@brson
Copy link
Contributor Author

brson commented Mar 16, 2013

@z0w0 that's amusing

lkuper added a commit to lkuper/rust that referenced this issue May 27, 2013
There were several old `#[doc(hidden)]` attributes in libstd and
libextra, left over from when rustdoc didn't hide private
definitions, tagged with `FIXME rust-lang#3538`.

Since rust-lang#3538 is now closed, I removed the `#[doc(hidden)]` attributes
as well as the FIXMEs, but I left `#[doc(hidden)]` in
libstd/task/spawn.rs and libstd/task/rt.rs since those two are
apparently `pub`, as well as in libextra/std.rc since std/extra is
`pub`.
bors added a commit that referenced this issue May 27, 2013
There were several old `#[doc(hidden)]` attributes in libstd and
libextra, left over from when rustdoc didn't hide private
definitions, tagged with `FIXME #3538`.

Since #3538 is now closed, I removed the `#[doc(hidden)]` attributes
as well as the FIXMEs, but I left `#[doc(hidden)]` in
libstd/task/spawn.rs and libstd/task/rt.rs since those two are
apparently `pub`, as well as in libextra/std.rc since std/extra is
`pub`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

3 participants