rustdoc search command

[steveklabnik]

Issue by brson
Saturday Apr 14, 2012 at 19:08 GMT

For earlier discussion, see rust-lang/rust#2207

This issue was labelled with: A-an-interesting-project, A-rustdoc, I-enhancement, P-low in the Rust repository

---

I want to be able to write rustdoc search vec::each and have rustdoc tell me the docs. It would use the following algorithm:

• Locate all the source crates (.rc files) under the current path
• Locate all the compiled crates used by those source crates
• Scan the all the found source and compiled crates for matching items/methods/variants, etc
• Generate the docs for all the matches
• Maybe provide interactive selection when there are multiple matches

Requires #2206

[estebank]

Even though the project is not an official part of rust-lang, racer's master now supports fetching the documentation string from any element it can find:

% racer complete-with-snippet std::fs::File                                                                                                                                                       
MATCH File;File;53;11;.../libstd/fs.rs;Struct;pub struct File;"A reference to an open file on the filesystem.\n\nAn instance of a `File` can be read and/or written depending on what options\nit was opened with. Files also implement `Seek` to alter the logical cursor\nthat the file contains internally.\n\n# Examples\n\n```no_run\nuse std::io::prelude::*\;\nuse std::fs::File\;\n\n# fn foo() -> std::io::Result<()> {\nlet mut f = try!(File::create(\"foo.txt\"))\;\ntry!(f.write_all(b\"Hello, world!\"))\;\n\nlet mut f = try!(File::open(\"foo.txt\"))\;\nlet mut s = String::new()\;\ntry!(f.read_to_string(&mut s))\;\nassert_eq!(s, \"Hello, world!\")\;\n# Ok(())\n# }\n```"
MATCH FileType;FileType;143;11;.../libstd/fs.rs;Struct;pub struct FileType(fs_imp::FileType)\;;"An structure representing a type of file with accessors for each file type."
%

[Ruin0x11]

Just letting people know that I'm currently working on such a tool, oxidoc. Feedback on the current design and contributions are highly encouraged.

[Centril]

Feels like racer / oxidoc suffices and there has been no movement for more than a year, so I'm closing this.