Home

Welcome to the YARD wiki! The YARD acronym can be expanded in any of several ways (the ambiguity is semi-purposeful):

• "Yay! A Ruby Documentation tool"
• "Yarr! A Ruby Documentation tool" (on Pirate day)
• "Yet Another Ruby Documentation tool"
• "You Are Riting Docs!"

Here are some possibly useful pages:

• 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