yard

yard command [options]

yard (Yay! A Ruby Documentation Tool) generates API documentation from Ruby source code. It parses specially formatted comments above classes, modules, and methods to produce browsable HTML documentation with cross-references and search.YARD uses its own tag syntax (such as @param, @return, @example) within comments to describe method signatures, return types, and usage examples. It also supports Markdown and other markup formats for free-form documentation within comments.The server subcommand starts a local web server for live documentation browsing during development. The stats subcommand reports documentation coverage, and --list-undoc identifies undocumented code. Templates control the HTML output layout and can be customized or replaced entirely.

doc

Generate docs.

Start server.

Show statistics.

Document gems.

Show documentation.

Show changes in documentation.

List undocumented objects.

Ruby-specific. YARD syntax in comments. Gem required.

YARD (Yay! A Ruby Documentation Tool) was created as a modern replacement for RDoc.

rdoc(1), ri(1), ruby(1), gem(1), bundle(1)