Home

Tutorials and Examples

This is an attempt to create a resource to assist with the creation of handlers, parsers, code objects, templates, and other resources necessary to integrate with the YARD gem. This is a starting point to capture some of the information that I learned while creating the Cucumber extension for YARD.

• Creating a YARD Parser

  Want YARD to assist to recognize files of different types? You must first describe to YARD how to parse these files by creating a parser and then registering it.

• Creating a YARD Handler

  YARD understands the files you are after, thanks to your work creating a custom parser (or is it already processing the file type) and now you want to convert the contents into lean, mean fighting objects that YARD understands.

• Creating or updating a YARD Template

  YARD has created objects and now you want to display them in an existing template or create a new template.