Skip to content

Commit 226c77d

Browse files
committed
rustdoc: add re-export info to RawSearchIndex type def
1 parent 6bcca5b commit 226c77d

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

src/librustdoc/html/static/js/externs.js

+13-6
Original file line numberDiff line numberDiff line change
@@ -239,20 +239,27 @@ let FunctionType;
239239
* `doc` contains the description of the crate.
240240
*
241241
* `p` is a list of path/type pairs. It is used for parents and function parameters.
242+
* The first item is the type, the second is the name, the third is the visible path (if any) and
243+
* the fourth is the canonical path used for deduplication (if any).
244+
*
245+
* `r` is the canonical path used for deduplication of re-exported items.
246+
* It is not used for associated items like methods (that's the fourth element
247+
* of `p`) but is used for modules items like free functions.
242248
*
243249
* `c` is an array of item indices that are deprecated.
244250
* @typedef {{
245251
* doc: string,
246252
* a: Object,
247253
* n: Array<string>,
248-
* t: String,
254+
* t: string,
249255
* d: Array<string>,
250-
* q: Array<[Number, string]>,
251-
* i: Array<Number>,
256+
* q: Array<[number, string]>,
257+
* i: Array<number>,
252258
* f: string,
253-
* p: Array<Object>,
254-
* b: Array<[Number, String]>,
255-
* c: Array<Number>
259+
* p: Array<[number, string] | [number, string, number] | [number, string, number, number]>,
260+
* b: Array<[number, String]>,
261+
* c: Array<number>,
262+
* r: Array<[number, number]>,
256263
* }}
257264
*/
258265
let RawSearchIndexCrate;

0 commit comments

Comments
 (0)