{"repo":"lsegal/yard","free":true,"listed":false,"github":"https://github.com/lsegal/yard","clone":"git clone https://github.com/lsegal/yard.git","description":"YARD is a Ruby Documentation tool. The Y stands for \"Yay!\"","language":"Ruby","stars":2010,"topics":["yard","rdoc","ruby-documentation","yardoc","ruby","documentation","tool"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"YARD: Yay! A Ruby Documentation Tool Synopsis 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. Below is a summary of some of YARD's notable features. Feature List 1. Builtin RDoc/Markdown Hybrid Support : YARD ships with a builtin markup renderer that supports both RDoc and Markdown formatting out of the box—no external gem required. You can freely mix RDoc-style and Markdown-style documentation without installing any additional libraries. 2. 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. These tags should be able to happily sit side by side RDoc formatted documentation, but provide a much more consistent and usable way to describe important information about objects, such as what parameters they take and what types they are expected to be, what type a method should return, what exceptions it can raise, if it is deprecated, etc.. It also allows information to be better (and more consistently) organized during the output generation phase. You can find a list of tags in the {file:docs/Tags.md#taglist Tags.md} file. YARD also supports an optional \"types\" declarations for certain tags. This allows the developer to d","default_branch":null,"files":null,"tree":[],"storefront":"/r/lsegal","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/lsegal/yard/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}