Home

YARD: Yay! A Ruby Documentation Tool

YARD is a documentation tool for Ruby created by Loren Segal in 2007.

Guides:

• Getting Started Guide - Basic usage of YARD
• Tags Syntax and Overview - How to use tags
• Templates Overview - How to customize a template
• What's New in YARD - Updates on YARD's progress
• Who's Using YARD? - A list of projects and organizations making use of YARD

Other Resources:

• YARD Homepage

• YARD Guides

• YARD Documentation

• YARD Mailing List

• Rubydoc.info Github and Gem Documentation

• Assumptions - overview of @yardoc@ assumptions

• Cache File Overview - overview of @.yardoc@ contents

• File Tree Overview - overview of the YARD file tree

• Who's Using YARD? - a list of projects and organizations making use of YARD