Classes & Modules
Attributes
| Name | Visibility | R/W | Description |
|---|---|---|---|
| doc_dir | public | R | the directory we search for original documentation |
| formatter | public | R | the formatting we apply to the output |
| list_classes | public | R | should we just display a class list and exit |
| list_names | public | R | should we display a list of all names |
| use_stdout | public | RW | No not use a pager. Writable, because ri sets it if it can‘t find a pager |
| width | public | R | The width of the output line |
Methods
Class
| Visibility | Signature |
|---|---|
| public | new () |
Instance
| Visibility | Signature |
|---|---|
| public | displayer () |
| public | parse (args) |
| public | path () |
| public | raw_path () |
| public | show_version () |
Class Method Detail
new()
Instance Method Detail
displayer()
Return an instance of the displayer (the thing that actually writes the information). This allows us to load in new displayer classes at runtime (for example to help with IDE integration)
parse(args)
Parse command line options.
path()
Return the selected documentation directories.
raw_path()
show_version()
Show the version and exit