Ruby documentation system RDoc 3.10 released

RDoc 3.10 is released. RDoc is a file system for Ruby source code. Like JavaDoc, RDoc can read the original file, analyze the syntax information and comment text in the source code, and generate documents in HTML format. Different from JavaDoc, RDoc can generate pretty documentation even if the source code does not have any comments. It is easy to write RDoc while writing the source program. Ruby's internal database library and standard library documentation are both generated using RDoc. You can use the ri command to access these documents, but it also depends on how you install Ruby.

This version enhances some features and fixes some bugs, including:

Major enhancements:

◆ Improved RDoc HTML output.

◆ More document formats are supported: TomDoc 1.0.0-RC1 and Rd.

◆ Now you can save and load option files.

Minor improvements:

◆ The HTML title now has an id that matches the title, such as "= Hello !" Displayed as "

◆ The class or method label can be linked to the related content of this class or method by adding.

◆ For HTML output, SomeClass. method_name and SomeClass # method_name in RDoc are used for remote methods and attributes.: method_name and # method_name are used for local methods.

◆ Improved syntax highlighting of Ruby code.

◆ Added the rdoc-label Link Mechanism, which allows two-way links.

◆ The image path in the https url can now be converted into the + + tags format.

◆ Added RDoc: Comment to process the Comment.

In addition, some bugs have been fixed in this version. For more information, see RDoc release notes.

Rdoc documentation: http://rdoc.rubyforge.org/

: Https://github.com/rdoc/rdoc