Class | YARD::CodeObjects::ExtraFileObject |
In: |
lib/yard/code_objects/extra_file_object.rb
|
Parent: | Object |
An ExtraFileObject represents an extra documentation file (README or other file). It is not strictly a CodeObject (does not inherit from `Base`) although it implements `path`, `name` and `type`, and therefore should be structurally compatible with most CodeObject interfaces.