YARD is a documentation generation tool for the Ruby programming language.
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.
YARD is free and open source software.
- RDoc/SimpleMarkup Formatting Compatibility: YARD is made to be compatible with RDoc formatting. YARD does no processing on RDoc documentation strings, and leaves this up to the output generation tool to decide how to render the documentation.
- Yardoc Meta-tag Formatting Like Python, Java, Objective-C and other languages: YARD uses a ‘@tag’ style definition syntax for meta tags alongside regular code documentation. YARD also supports an optional “types” declarations for certain tags. This allows the developer to document type signatures for ruby methods and parameters
- Custom Constructs and Extensibility of YARD: YARD is designed to be extended and customized by plugins.
- Raw Data Output: YARD also outputs documented objects as raw data (the dumped Namespace) which can be reloaded to do generation at a later date, or even auditing on code.
- Local Documentation Server: YARD can serve documentation for projects or installed gems (similar to gem server) with the added benefit of dynamic searching, as well as live reloading.
- Template Customization – customize templates using a specially designed templating system. The design allows plugin developers to make small modifications to a template without breaking changes that may have been made from another plugin. This means you can install multiple plugins that each make independent modifications without running into problems with your template. It also allows you to easily make small changes (like adding your own stylesheets) without digging into any markup.
|New to Linux? Read our Linux for Starters series.|
|The largest compilation of the best free and open source software in the universe. Supplied with our legendary ratings charts.|
|Hundreds of in-depth reviews offering our unbiased and expert opinion on software.|
|Alternatives to Google's Products and Services examines your options to migrate from the Google ecosystem with open source Linux alternatives.|
|Essential Linux system tools looks at small, indispensable utilities, useful for system administrators as well as regular users.|
|Linux utilities to maximise your productivity. Small, indispensable tools, useful for anyone running a Linux machine.|
|Home computers became commonplace in the 1980s. Emulate home computers such as the ZX81, Amstrad CPC, and ZX Spectrum.|
|Now and Then examines how promising open source software fared over the years.|
|Linux at Home looks at a range of home activities where Linux can play its part, making the most of our time at home, keeping active and engaged.|
|Linux Candy opens up to the lighter side of Linux. Have some fun!|
|Best Free Android Apps. There's a strict eligibility criteria for inclusion in this series|
|These best free books accelerate your learning of every programming language|
|These free tutorials offer the perfect tonic to the free programming books series|
|Stars and Stripes is an occasional series looking at the impact of Linux in the USA|