rdoc version 3.3 has been released!
- GitHub - rdoc/rdoc: RDoc produces HTML and online documentation for Ruby projects. RDoc includes the rdoc and ri tools for generating and displaying online documentation.
- http://rdoc.rubyforge.org/
- Pull requests · rdoc/rdoc · GitHub
RDoc produces HTML and command-line documentation for Ruby projects.
RDoc
includes the +rdoc+ and +ri+ tools for generating and displaying online
documentation.
See RDoc for a description of RDoc’s markup and basic use.
Changes:
3.3 / 2010-01-03
- Minor enhancements
-
The coverage report can now report undocumented method parameters
including methods defined in C.rdoc -C
gives a standard report,rdoc -C1
includes
method parameters. Method parameters are considered documented if
they’re
marked-up with +,or .
-
The C parser now uses "*args instead of “” if no
call-seq was provided to give names to the arguments.
-
- Bug fixes
- The C parser now records the file location of aliases, attributes,
constants and methods allowing -C to work on C files. - Darkfish now handles dots in call-seq allowing ary.insert(index,
obj) to display correctly. Patch #6 by KUBO Takehiro. - Improved processing of meta-programmed methods when followed by
unparseable
syntax. RubyForge patch #28653 by Aidan Cully. - rdoc now touches the flag file when it create the output directory.
Prevents the “isn’t an RDoc directory” error if rdoc crashes. - RDoc now properly converts to the expected output encoding.
RubyForge bug
#28791 by Dzmitry Prakapenka. - Restored parsing of block comments. RubyForge bug #28668 by Stefano
Crocco. - Metaprogrammed methods defined with blocks no longer confuse the
ruby
parser. RubyForge bug #28370 by Erik H… - ri no longer displays all methods in the inheritance chain.
- The C parser now records the file location of aliases, attributes,