Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 60 lines (43 sloc) 1.857 kb
83b2134 @drbrain Update TODO with a proper version for the next release of RDoc 3
drbrain authored
1 This file contains some things that might happen in RDoc, or might not.
2 Forward Looking Statements applies.
e3050f0 @drbrain Integrated search from sdoc
drbrain authored
3
823bcc3 @drbrain Documentation may now be written in markdown format, markdown is fully w...
drbrain authored
4 === RDoc::VERSION.succ
5
6 Blockers:
7
51820d5 @drbrain Fixed various typos discovered by rdoc-spellcheck
drbrain authored
8 * Update LICENSE to match ruby's switch
823bcc3 @drbrain Documentation may now be written in markdown format, markdown is fully w...
drbrain authored
9 * The alias keyword should not be bidirectional
10 * Fix RDoc::Parser#use_markup to handle the filename (see TODO)
f8016a2 @drbrain Added support for Markdown hard line breaks.
drbrain authored
11 * Restore backwards compatibility due to paragraph text joining from existing
12 ri files
50be8bd @drbrain Reorganized and improved documentation around choosing a default comment...
drbrain authored
13 * Fix consumption of , after link like: RDoc[rdoc-ref:RDoc], <- comma here
dabcab8 @drbrain Removed RDoc::RDocError const_missing shim
drbrain authored
14 * Remove support for links like Matrix[*rows]
823bcc3 @drbrain Documentation may now be written in markdown format, markdown is fully w...
drbrain authored
15
16 Nice to have:
e3050f0 @drbrain Integrated search from sdoc
drbrain authored
17
dabcab8 @drbrain Removed RDoc::RDocError const_missing shim
drbrain authored
18 * Parse only changed files (like in ruby)
dd0c878 @drbrain Idea: add a page to show how awesome your documentation is
drbrain authored
19 * Page of Glory (or Shame) in HTML output showing documentation coverage
20 statistics.
86640e0 @drbrain Update documentation
drbrain authored
21 * Link to the parent-class implementation of methods that use super
98bbc29 @drbrain RDoc::Task needs to know this a project is tomdoc
drbrain authored
22 * Add direct accessor to RDoc::Options to RDoc::Task
83b2134 @drbrain Update TODO with a proper version for the next release of RDoc 3
drbrain authored
23 * Remove "Public" in HTML output if there are only public methods
24 * Method markup support for rd documentation (per rd syntax)
062efe8 @drbrain Fix lexing of `a bb <<-HEREDOC`. Issue #75
drbrain authored
25 * Improve SIGINFO handling
26 * Global variable support
f21c2c2 @drbrain Move information on plugin writing to the DEVELOPERS document
drbrain authored
27 * Provide the code_object to directive handlers
e3050f0 @drbrain Integrated search from sdoc
drbrain authored
28
c0b06f6 @drbrain Add bugs to fix
drbrain authored
29 === 4
e3050f0 @drbrain Integrated search from sdoc
drbrain authored
30
31 API changes to RDoc
32
33 * RDoc::TopLevel#add_method should automatically create the appropriate method
34 class rather than requiring one be passed in.
621c1f9 @drbrain Use comment_location instead of comment for the search_record of classes...
drbrain authored
35 * Remove #comment= from Context subclasses in favor of #add_comment
ed5f3d3 @drbrain Implement github format markdown code fences.
drbrain authored
36 * Add versions to RDoc::Markup syntax tree marshal format
51820d5 @drbrain Fixed various typos discovered by rdoc-spellcheck
drbrain authored
37 * Comments can no longer be Strings
e3050f0 @drbrain Integrated search from sdoc
drbrain authored
38
4a8b7be @drbrain Exclude TAGS files that may have been included in gems from parsing. Is...
drbrain authored
39 === Crazy Ideas
40
f87f85d @drbrain Renaming CodeObject and subclasses is just crazy
drbrain authored
41 * Auto-normalize heading levels to look OK. It's weird to see an <h1> in
42 the middle of a method section.
43 * RDoc::CodeObject
44 * Move into own namespace
45 * Rename TopLevel to File
46 * Rename Context to Container
47 * Rename NormalClass to Class
d4e94b8 @drbrain Update TODO from accessibility call
drbrain authored
48
49 === Accessibility
50
51 Page title in right hand side
52
53 Table of contents in left hand side as sub-list under main heading
54
55 For class list, never method list, method summary at top
56
57 table-of-contents-navigation div => nav + role="navigation"
58
59 type "mod", focus is still on "mod"
Something went wrong with that request. Please try again.