@@ -10,53 +10,37 @@ files. RDoc includes the +rdoc+ and +ri+ tools for generating and displaying
1010online documentation.
1111
1212At this point in time, RDoc 2.x is a work in progress and may incur further
13- API changes beyond what has been made to the RDoc 1.0.1. Command-line tools
14- are largely unaffected, but internal APIs may shift rapidly.
13+ API changes beyond what has been made to RDoc 1.0.1. Command-line tools are
14+ largely unaffected, but internal APIs may shift rapidly.
1515
1616See RDoc for a description of RDoc's markup and basic use.
1717
18- == TEMPLATE NOTE:
19-
20- RDoc comes with five built-in HTML templates. We use a 3rd party template,
21- however, for RDoc's own documentation site[http://rdoc.rubyforge.org]. This
22- template is Hanna[http://github.com/mislav/hanna/tree/master].
23-
24- We strongly are considering making Hanna as RDoc's default template
25- in a future release, but for now this template can be downloaded separately
26- and used with the +-T+ option.
27-
2818== SYNOPSIS:
2919
3020 gem 'rdoc'
3121 require 'rdoc/rdoc'
3222 # ... see RDoc
3323
3424== BUGS:
35- ---
36- RDoc's Fortran 95 support is pretty broken right now.
37- The rdoc-f95[http://www.gfd-dennou.org/library/dcmodel/rdoc-f95/] project has
38- patches for RDoc 1.x that provide excellent Fortran 95 support. Properly
39- supporting Fortran 95 requires a rewrite of RDoc's markup engine, which
40- is high on our list of goals. The Fortran 95 issue can be tracked
41- here[http://rubyforge.org/tracker/index.php?func=detail&aid=21542&group_id=627&atid=2475].
42- ---
25+
4326The markup engine has lots of little bugs. In particular:
4427* Escaping does not work for all markup.
4528* Typesetting is not always correct.
4629* Some output formats (ri, for example) do not correctly handle all of the
4730 markup.
48- The markup engine needs a rewrite, which can be tracked here[http://rubyforge.org/tracker/index.php?func=detail&aid=21540&group_id=627&atid=2475].
49- ---
31+
5032RDoc has some subtle bugs processing classes that are split across multiple
5133files (bugs that may or may not manifest depending on the order in which
5234the files are encountered). This issue can be tracked here[http://rubyforge.org/tracker/index.php?func=detail&aid=22135&group_id=627&atid=2475].
53- -------
35+
5436If you find a bug, please report it at the RDoc project's
5537tracker[http://rubyforge.org/tracker/?group_id=627] on RubyForge:
5638
5739== LICENSE:
5840
59- RDoc is Copyright (c) 2001-2003 Dave Thomas, The Pragmatic Programmers,
60- portions (c) 2007-2008 Eric Hodel. It is free software, and may be
61- redistributed under the terms specified in the README file of the Ruby
62- distribution.
41+ RDoc is Copyright (c) 2001-2003 Dave Thomas, The Pragmatic Programmers.
42+ Portions (c) 2007-2009 Eric Hodel. Portions copyright others, see individual
43+ files for details.
44+
45+ It is free software, and may be redistributed under the terms specified in the
46+ README file of the Ruby distribution.
0 commit comments