mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

rustdoc-json-types: Improve ItemSummary::path docs

Browse Source
This commit is contained in:
Nixon Enraght-Moony 2022-10-28 01:43:37 +01:00
parent 0da281b606
commit 064ad83cc3
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/rustdoc-json-types/lib.rs
View File

@ -51,6 +51,11 @@ pub struct ItemSummary {
pub crate_id: u32, pub crate_id: u32,
/// The list of path components for the fully qualified path of this item (e.g. /// The list of path components for the fully qualified path of this item (e.g.
/// `["std", "io", "lazy", "Lazy"]` for `std::io::lazy::Lazy`). /// `["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>, pub path: Vec<String>,
/// Whether this item is a struct, trait, macro, etc. /// Whether this item is a struct, trait, macro, etc.
pub kind: ItemKind, pub kind: ItemKind,