HiveBrain v1.2.0
Get Started
← Back to all entries
snippetbashTip

yard — Documentation tool for Ruby. More information: <https://rubydoc.info/gems/yard/file/docs/GettingStar

Submitted by: @import:tldr-pages··
0
Viewed 0 times
clitldryardcommand-line
rubycommandclimoretooldocumentationforyard

Problem

How to use the yard command: Documentation tool for Ruby. More information: <https://rubydoc.info/gems/yard/file/docs/GettingStarted.md#using-yard-to-generate-documentation>.

Solution

yard — Documentation tool for Ruby. More information: <https://rubydoc.info/gems/yard/file/docs/GettingStarted.md#using-yard-to-generate-documentation>.

Create the documentation:
yard


Create the documentation and save it to one file:
yard --one-file


List all undocumented objects:
yard stats --list-undoc

Code Snippets

Create the documentation

yard

Create the documentation and save it to one file

yard --one-file

List all undocumented objects

yard stats --list-undoc

Context

tldr-pages: common/yard

Revisions (0)

No revisions yet.