mirror of
https://github.com/rust-lang/rust.git
synced 2024-11-23 07:14:28 +00:00
rustdoc-json-types: Improve ItemSummary::path docs
This commit is contained in:
parent
0da281b606
commit
064ad83cc3
@ -51,6 +51,11 @@ pub struct ItemSummary {
|
||||
pub crate_id: u32,
|
||||
/// The list of path components for the fully qualified path of this item (e.g.
|
||||
/// `["std", "io", "lazy", "Lazy"]` for `std::io::lazy::Lazy`).
|
||||
///
|
||||
/// Note that items can appear in multiple paths, and the one chosen is implementation
|
||||
/// defined. Currenty, this is the full path to where the item was defined. Eg
|
||||
/// [`String`] is currently `["alloc", "string", "String"]` and [`HashMap`] is
|
||||
/// `["std", "collections", "hash", "map", "HashMap"]`, but this is subject to change.
|
||||
pub path: Vec<String>,
|
||||
/// Whether this item is a struct, trait, macro, etc.
|
||||
pub kind: ItemKind,
|
||||
|
Loading…
Reference in New Issue
Block a user