yardoc

Reference:

• installation
• guides
• tags
• cheatsheet

Install

$ gem install yard
$ gem install redcarpet

NOTE: Install of redcarpet may not be required. Yard now comes with several parsers preinstalled.

To run...

Run for all files

$ bundle exec yard doc
$ bundle exec yard doc -m markdown

NOTE: -m markdown generates docs using GitHub style markdown. The default is RDoc.

Run for directory

$ bundle exec yard doc app
$ bundle exec yard doc -m markdown app

Run for a file

$ bundle exec yard doc app/models/my_model.rb
$ bundle exec yard doc -m markdown app/models/my_model.rb

@see examples

@see Class::Name
@see Class::Name#method_name
@see https://a.link/ text to display