Skip to content
Corey Richardson edited this page Jun 28, 2013 · 12 revisions

rustdoc currently needs some love, and I'm going to give it some.

Architecture

  • take AST, make pretty docs. easy!

Pain points with current rustdoc

  • Implementation of Foo for Bar where <useless stuff> (from SL. where -> given?)

New features

  • Unformatted JSON/XML (undecided) output
  • More complete TOCs, indexes, links to all items documented
  • Interactive browser interface (live search, toggle platform cfg's)
  • every symbol should be able to be linked to its documentation (eg, types, methods, functions)
  • new attribute that instructs rustdoc to inline a nested module into its parent's documentation
  • document macros
  • navigate visibility graph and don't generate docs for stuff which isn't visible
  • document macro-generated code
  • your feature requests here!

New bugs

  • your bug requests here!

Progress

  • this will track pull requests and status updates as I create them.

All Categories:

Clone this wiki locally