dannyrb/yard

YARD: Yay! A Ruby Documentation Tool

This is a simple console app used to demonstrate the benefits of YARD.

Usage

# No Arguments, prints a "help" message
ruby RailsCLI.rb

# Call a specific task w/ arguments
# ex: ruby RailsCLI.rb <task> [arg1 arg2]
ruby RailsCLI.rb new verbose

Generate API Docs

Required gem install yard

#
yard server --reload **/*.rb

# https://msp-greg.github.io/yard/YARD/CLI/Yardoc.html
yardoc [options] [source_files [- extra_files]]

On Ruby CLIs

• ARGV array (how to access CLI options)
• OptParse Library (Built into Ruby)
• Thor gem (What Ruby's CLI uses)