Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

55 lines (44 sloc) 1.78 kb

This file contains some things that might happen in RDoc, or might not. Forward Looking Statements applies.

RDoc::VERSION.succ

Blockers:

  • Update LICENSE to match ruby's switch

  • The alias keyword should not be bidirectional

  • Fix RDoc::Parser#use_markup to handle the filename (see TODO)

  • Restore backwards compatibility due to paragraph text joining from existing ri files

  • Fix consumption of , after link like: RDoc[rdoc-ref:RDoc], <- comma here

  • Move modsort thing to RDoc::Store

Nice to have:

  • Reload the RDoc tree from an RI store

    • Re-run generators

    • Parse only changed files (like in ruby)

  • Page of Glory (or Shame) in HTML output showing documentation coverage statistics.

  • Link to the parent-class implementation of methods that use super

  • Add direct accessor to RDoc::Options to RDoc::Task

  • Remove “Public” in HTML output if there are only public methods

  • Method markup support for rd documentation (per rd syntax)

  • Improve SIGINFO handling

  • Global variable support

  • Page support for ri

  • Provide the code_object to directive handlers

  • Add RDoc::Constant#full_name

4

API changes to RDoc

  • Remove global state

    • Use top_levels argument for generators

  • Remove RDoc::RDocError

  • RDoc::TopLevel#add_method should automatically create the appropriate method class rather than requiring one be passed in.

  • Remove #comment= from Context subclasses in favor of #add_comment

  • Add versions to RDoc::Markup syntax tree marshal format

  • Comments can no longer be Strings

Crazy Ideas

  • Auto-normalize heading levels to look OK. It's weird to see an <h1> in the middle of a method section.

  • RDoc::CodeObject

    • Move into own namespace

    • Rename TopLevel to File

    • Rename Context to Container

    • Rename NormalClass to Class

Jump to Line
Something went wrong with that request. Please try again.