mirror of
https://github.com/ivuorinen/cheatsheet-tldr.git
synced 2026-01-26 11:33:59 +00:00
22 lines
421 B
Plaintext
22 lines
421 B
Plaintext
---
|
|
syntax: markdown
|
|
tags: [tldr, common]
|
|
source: https://github.com/tldr-pages/tldr.git
|
|
---
|
|
# 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`
|