Home
Dockmaster is a documentation generator for Ruby that takes documentation from source code and converts it into intuitive webpages. It is currently a work-in-progress and is not ready for release.
Dockmaster is run using the dockmaster command.
$ dockmaster [--options]There are several options that can be appended to the command:
| Option | Function |
|---|---|
-v, --version
|
Prints Dockmaster's version |
-d, --debug
|
Prints details about generation process |
-s, --serve
|
Launches a WEBrick server for the generated files |
-n, --no-build
|
Disables documentation generation (usually used alongside -s) |
-p, --include-private
|
Includes private methods/fields in generation (these are omitted by default) |
Dockmaster's check command evaluates the quality of documentation in source files.
The check command can be run by appending the command to the end of the dockmaster command:
$ dockmaster check [--options]The check command also has options that can be added:
| Option | Function |
|---|---|
-u, --suggestions
|
Allows the check command to output suggestions for ways to improve documentation |