TODO.rdoc 1.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  1. This file contains some things that might happen in RDoc, or might not.
  2. Forward Looking Statements applies.
  3. === 3.next
  4. * Update LICENSE to match ruby's switch
  5. * Reload the RDoc tree from an RI store
  6. * Re-run generators
  7. * Parse only changed files (like in ruby)
  8. * Page of Glory (or Shame) in HTML output showing documentation coverage
  9. statistics.
  10. * Link to the parent-class implementation of methods that use super
  11. * Add direct accessor to RDoc::Options to RDoc::Task
  12. * Remove "Public" in HTML output if there are only public methods
  13. * Method markup support for rd documentation (per rd syntax)
  14. * Improve SIGINFO handling
  15. * Global variable support
  16. * Page support for ri
  17. * Provide the code_object to directive handlers
  18. * Add markup parser documentation to DEVELOPERS.rdoc
  19. === 4
  20. API changes to RDoc
  21. * Remove global state
  22. * Remove RDoc::RDocError
  23. * RDoc::TopLevel#add_method should automatically create the appropriate method
  24. class rather than requiring one be passed in.
  25. * Remove #comment= from Context subclasses in favor of #add_comment
  26. * RDoc::CodeObject
  27. * Move into own namespace
  28. * Rename TopLevel to File
  29. * Rename Context to Container
  30. * Rename NormalClass to Class
  31. === Crazy Ideas
  32. * Auto-normalize heading levels to look OK. It's weird to see an <h1> in
  33. the middle of a method section.