SYNOPSISyard command [options]
DESCRIPTIONyard is an extensible documentation generation tool for the Ruby programming language. It enables the user to generate consistent, usable documentation that can be exported to a number of formats very easily, and also supports extending for custom Ruby constructs such as custom class level definitions.
Below are listed the commands that can be passed to the yard on the command line. For more details about a command, use yard help command from the command line.
- Views or edits current global configuration
- Returns the object diff of two gems or .yardoc files
- Displays a formatted object
- Generates documentation. yardoc(1) is a synonym of yard doc.
- Builds YARD index for gems
- Graphs class diagram using Graphviz
- Retrieves help for a command
- Generates .pot file from source code and extra documentation
- Lists all constant and methods. Uses yard doc --list.
- Lists all available markup types and libraries
- A tool to view documentation in the console like ri(1). yri(1) is a synonym of yard ri.
- Runs a local documentation server
- Prints documentation statistics on a set of files
AUTHORSyard has been developed by Loren Segal <[email protected]>.
This manual page has been written for the Debian Project by Cédric Boutillier (but may used by others).