YardT2 Documentation
Library Listings
- DescriptionVersionDate GMTCommit / svn
- Ruby 2.22.2.10 p4892018-03-28630232018-03-28T14:50:57Z
- Ruby 2.32.3.8 p4592018-10-17651362018-10-17T15:34:45Z
- Ruby 2.42.4.10 p3642020-03-31678792020-03-31T11:42:18Z
- Ruby 2.52.5.9 p2292021-04-0567939* for contributors2021-04-05T11:46:35Z
- Ruby 2.62.6.10 p2102022-04-1267958* for contributors2022-04-12T11:50:11Z
- Ruby 2.72.7.8 pp2252023-03-301f4d4558484b* for contributors2023-03-30T12:34:08Z
- Ruby 3.03.0.7 p2202024-04-23724a0711752f* for contributors2024-04-23T10:23:26Z
- Ruby 3.13.1.6 p2602024-05-29a777087be612* for contributors2024-05-29T03:54:36Z
- Ruby 3.23.2.6 p2342024-10-3063aeb018eb1c* for contributors2024-10-30T09:47:11Z
- Ruby 3.33.3.6 p1082024-11-0575015d4c1f69* for contributors2024-11-05T00:49:11Z
- Ruby mastermaster dev2024-12-208fd65cd8701c* for contributors2024-12-20T13:24:54Z
- Rails 4.x gem4.2.11.32020-05-1511f2bdf75a2020-05-15T18:34:31Z
- Rails 5.x gem5.2.8.12022-07-128030cff8082022-07-12T17:25:53Z
- Rails 6.x gem6.1.7.102024-10-2386864c2f662024-10-23T21:56:36Z
- Rails 7.x gem7.1.5.12024-11-14c02b10b5b92024-11-14T03:56:01Z
- Rails stable8.0.0.2024-11-1442fd826b7f2024-11-14T07:27:31Z
- Rails master8.1.0.alpha2024-11-14c02b10b5b9* for contributors2024-11-14T03:56:01Z
Libraries below are created from the main branches
- Capybara3.40.02024-04-140480f9012024-04-14T23:08:52Z
- Concurrent Ruby1.3.42024-11-25957cf7d02024-11-25T19:55:21Z
- EventMachine1.3.0.dev.12024-09-16e7320412024-09-16T19:37:09Z
- FFI1.17.02024-09-30c128ced2024-09-30T15:22:45Z
- GraphQL::Client0.18.02022-05-022c611762022-05-02T20:31:22Z
- LibXML Ruby5.0.22024-03-1256b96422024-03-12T04:14:27Z
- Mongo2.21.02024-11-226e624486f2024-11-22T07:56:50Z
- Mongoid9.0.22024-12-18ec18c8b402024-12-18T18:10:30Z
- Mysql20.5.62024-12-0458f8d002024-12-04T21:45:21Z
- nio4r2.7.42024-11-27315b1f62024-11-27T21:09:53Z
- Nokogiri1.18.0.rc12024-12-1622fe69ef2024-12-16T17:18:29Z
- Octokit master9.2.02024-12-19cc7d14212024-12-19T21:13:27Z
- Octokit 4-stable4.25.12022-07-0197ac5fbf2022-07-01T13:55:45Z
- PG1.6.0.rc12024-11-28c6d10472024-11-28T09:43:23Z
- Puma6.5.02024-12-114d7f4e77b2024-12-11T14:33:36Z
- Rack3.1.12024-12-11e9f2f2462024-12-11T06:34:39Z
- Rackup2.2.12024-11-15301b6dd2024-11-15T20:42:23Z
- Redis5.3.02024-12-093669beb2024-12-09T17:06:14Z
- RSpec3.14.0.pre2024-12-172bdca15e592024-12-17T21:42:15Z
- RuboCop1.69.22024-12-20f9e9c01dd2024-12-20T07:01:29Z
- RuboCop::Performance1.23.02024-12-139aef9ac872024-12-13T20:40:13Z
- RubyInstaller23.3.6-22024-12-20ca521c22024-12-20T14:34:55Z
- Selenium WebDriver4.28.0.nightly2024-12-19c0b45ad7142024-12-19T23:38:10Z
- SimpleCov0.22.02024-09-01b6c2d422024-09-01T10:07:20Z
- Sinatra4.1.12024-11-207b50a1bb2024-11-20T15:47:22Z
- SketchUp Ruby APISU2024.02024-04-04351f3a92024-04-04T15:18:19Z
- Sprockets4.2.12024-10-23ceac1ce12024-10-23T00:31:10Z
- SQLite32.5.0.rc12024-12-16423f9892024-12-16T15:09:06Z
- Timezone1.3.272024-11-17018ab9b2024-11-17T19:11:00Z
- TZInfo2.0.62024-11-260bdc62f2024-11-26T20:54:33Z
- Unicorn6.1.02024-11-171370f522024-11-17T21:30:28Z
- Yard0.9.372024-10-113c14200e2024-10-11T17:14:34Z
Please set font size, see settings...
Site updates done with ruby 3.4.0dev (2024-12-20 master 2f6c694977) +PRISM [x64-mingw-ucrt]
Browser Choice
As of Apr-2019, the Rails master method list contains approximately 12,800 items, and the AWS method lists have over 59,000 items. Having spent time trying to optimize the javascript for (large) list loading and searching, I'm familiar with the performance issues. The method list has a lot of UI functionality that one may find beneficial. I have found that Firefox does the best job of handling large lists.
What does '* for contributors' mean?
Developers / contributors often remove objects from documentation which are not considered part of the public API.
Libraries listed as '* for contributors' show all objects, and are meant for contributors to the repository.
Hence, if you are using the API, you should not use any classes, modules, methods, or constants that are notated as 'for internal use only'. All of these items will have a red vertical bar (or border) distinguishing them from other objects. Please use the other library versions for API reference.
When you have a minute - UI Guide
YardT2 has quite a few features that are not based on RDoc or YARD. Please read the YardT2 UI Guide, in particular, the 'Search' information, as searching the 'Methods' list works for both name and namespace. 'Start of name' and 'anywhere in name' searches are supported.
Library Notes
All libraries are pulled from their respective GitHub repos. The branch / tag criteria is shown below. The last commit information and date (GMT) are retrieved via the GitHub API.
Ruby
These libraries should correspond to the most recent ruby-lang.org packages. Only 'Ruby trunk' includes c source code.
- Ruby 2.2last tag matching v2_2_
- Ruby 2.3last tag matching v2_3
- Ruby 2.4last tag matching v2_4
- Ruby 2.5last tag matching v2_5
- Ruby 2.6last tag matching v2_6
- Ruby trunktrunk branch (current repo)
Version and date info is retrieved from version.h
Rails
- Rails 4.x gemlast tag matching v4.
- Rails 5.x gemlast tag matching v5.
- Rails stablelast 'stable' branch (currently 6-0-stable)
- Rails mastermaster branch (current repo)
Version info is retrieved from version.rb.
- YardT2 parses included do blocks.
- YardT2 parses alias_attribute, cattr, mattr, class_attribute, config_accessor, delegate, and deprecate statements.
- Most of the 'Rails Guides' appear in the 'Docs' list, and they link back to object documentation.
AWS SDK for Ruby
- AWS SDK for Ruby v3master branch
Version info is retrieved from VERSION file. At present, the gem is generated frequently, so the branch is rarely more than a few commits past the most recent gem.
As of April 2019, the AWS SDK for Ruby has almost 17,000 classes and modules, and 59,000 methods.
Loading the Methods list takes a long time, and is not a good idea on tablets. Once loaded, it searches well and is cached, unlike other implementations. Resizing the LIST pane when the Method list is visible is not recommended.
Simply put, loading 59k items into any DOM element is well outside of standard use.
Comments, Bugs, etc
For missing or incorrect documentation, please post an issue on GitHub. If you like the docs, feel free to star the GitHub repo.
For UI suggestions and other questions / comments...
Thanks
A very special thank you to Loren Segal for his work in creating and maintaining YARD.
Also, thank you to all the contributors that have taken the time to comment / document these libraries.
Copyright
All documented software libraries are copyright their respective owners. See their GitHub repos (AWS SDK for Ruby, Ruby on Rails, Ruby) for copyright and license information.
ToDo
- Release yard-t2 as a gem - need to write more tests, refactor some code, clean up css...
- Add code to detect super calls in method bodies?
- Add 'bundled gems' to Ruby documentation.
- Create code to document test code.
- Create code to document template code (erb, etc).
- Rails - more DSL methods to doc?
- RDoc - additional directives?