What is StrippedItem in rustdoc?

help
1

hi, I have no idea about what variant StrippedItem of enum ItemKind in src/librustdoc/clean/types.rs is.

2

Ironically, I couldn't find any good documentation about stripped items in rustdoc. Stripped items are basically private items irrelevant for your public documentation, including:

  • hidden items:

    #[doc(hidden)]
pub struct Foo;

  • private imports:

    extern crate foo;
use foo::Foo;

  • private items:

    struct Foo;

The four submodules in rustdoc::passes, strip_hidden, strip_priv_imports, strip_private and stripper contain the source code of the passes rustdoc makes in order to strip your documentation from the items I listed above.

3

Thanks.
But can I do something to make Private items unsctripped?

4

Yes, with the --document-private-items cli option

5

Thank you. It works.

6

This topic was automatically closed 90 days after the last reply. We invite you to open a new topic if you have further questions or comments.