mirror of
https://github.com/tldr-pages/tldr.git
synced 2025-08-22 03:44:00 +02:00
16 lines
328 B
Markdown
16 lines
328 B
Markdown
# 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`
|