YARD

Yard is a Ruby tool to make generating documentation convenient to both write and read.

The main goal is to provide cleaner HTML output and a consistent way to add more meta-data about classes.

It enables the user to generate consistent, usable documentation that can be exported to a number of formats very easily, and also supports extending for custom Ruby constructs such as custom class level definitions.

Features:

• Yardoc Meta-tag Formatting
• RDoc Formatting Compatibility
• A Local Documentation Server
• Custom Constructs and Extensibility
• Template Customization
• Raw Data Output

What is new in this release:

• Make ExtraFileObject type a symbol.
• Disabled ree on Travis CI.
• Filter out hidden modules from mixin listing.

What is new in version 0.8.2.1:

• Ensured that defaults are inherited from parent class.

What is new in version 0.8.0:

• Updated docs for option tag.
• Private badge should be lowercase in item summary.
• Updated Library class docs.

What is new in version 0.7.3:

• Fix reference to changed method name in Getting Started documentation.
• Remove unnecessary file? stub, fixes JRuby spec.
• Add ruby193 to suite.

What is new in version 0.7.2:

• Added Gemfile for Bundler support.

What is new in version 0.7.0:

• Discuss new -t guide template in WhatsNew.
• Update readme for release.
• Added documentation about new --yardopts flag.
• Ignore doc_guide dir.

What is new in version 0.6.8:

• Ensure that load_markup_provider loads type as symbol.

What is new in version 0.6.7:

• Fixed gemspec date.

What is new in version 0.6.4:

• Typos. Tested. Now this patch looks goooood.
• RackMiddleware should now pass 404 responses up to the next middleware in the stack.