kit-doc edge

ExtraFileObject class
YARD::CodeObjects::ExtraFileObject
View Source


Link to this section Summary ⚠️ Private APIs are currently hidden.


Link to this section Instance methods 4

In the original code flow, the html rendering is done directly in templates.

This allows us to access the rendered version anywhere, and to cache it.

Note: this is an addition, not present in the original class.

Cache the TOC version (usefull for the file title for instance).

Note: this is an addition, not present in the original class.

Make this object interface compatible with Base CodeObjects.

Link to this method

#initialize(filename, contents = nil)

View Source RUBYConstructor