2025-03-14 21:59:59 -06:00
|
|
|
# yard
|
|
|
|
|
|
|
|
|
|
> Documentation tool for Ruby.
|
2025-12-16 10:20:31 -07:00
|
|
|
> More information: <https://rubydoc.info/gems/yard/file/docs/GettingStarted.md#using-yard-to-generate-documentation>.
|
2025-03-14 21:59:59 -06:00
|
|
|
|
|
|
|
|
- Create the documentation:
|
|
|
|
|
|
|
|
|
|
`yard`
|
|
|
|
|
|
|
|
|
|
- Create the documentation and save it to one file:
|
|
|
|
|
|
|
|
|
|
`yard --one-file`
|
|
|
|
|
|
|
|
|
|
- List all undocumented objects:
|
|
|
|
|
|
|
|
|
|
`yard stats --list-undoc`
|
