Get the App
SLTechnology News&Howtos  ›  Development  › 

Which bug has been fixed by Ruby's documentation system RDoc 3.10

Shulou Source: shulou.com Published: 2022-06-02 02:30:24 10月03日 Update

Today, Xiaobian to share with you about Ruby document system RDoc 3.10 repaired which bug-related knowledge points, detailed content, clear logic, I believe that most people still know too much about this knowledge, so share this article for your reference, hope that you have something to learn after reading this article, let's take a look at it.

RDoc 3.10 has been released, and RDoc is a documentation 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. Unlike JavaDoc, RDoc can generate pretty beautiful documentation even without any comments on the source code. Writing RDoc while writing source code can be said to be easy. Ruby's built-in libraries and standard library documents are generated in RDoc. You should be able to access these documents using the ri command, but it also depends on how you install Ruby.

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

Key enhancements:

◆ improves RDoc HTML output.

◆ supports more document formats: TomDoc 1.0.0-RC1 and Rd formats.

◆ can now save and load options files.

Small improvements:

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

The tag of a ◆ class or method can be linked to the relevant content of this class or method by adding an "@".

◆ is for HTML output, SomeClass.method_name and SomeClass#method_name in RDoc are for remote methods and properties, and:: method_name and#method_name is for local methods.

◆ improves the syntax highlighting of Ruby code.

◆ has added a rdoc-label link mechanism to allow two-way links.

The picture path in ◆ HTTPS URL can now be converted to +

+ tags form.

◆ has added RDoc::Comment to handle comments.

These are all the contents of the article "which bug has been fixed by Ruby's documentation system RDoc 3.10". Thank you for reading! I believe you will gain a lot after reading this article. The editor will update different knowledge for you every day. If you want to learn more knowledge, please pay attention to the industry information channel.

Tags: Documents content methods knowledge articles systems formats source code links generation differences files more titles comments syntax output large beautiful easy Apple Docker Huawei Linux macOS MariaDB Microsoft MySQL NVidia OPPO Reno Shulou Tech Info vpn OPPO Reno Shulou Information Microsoft