const classcamRubyPlugin::RubyDocs
sys::Obj camRubyPlugin::RubyDocs : camembert::PluginDocs
RubyDocs : Provides help pane documentation for Ruby
- dis
virtual override Str dis()
User friendly dsplay name
- findSrc
virtual override FileItem? findSrc(Str query)
Return a FileItem for the document matching the current source file (if known) Query wil be what's in the helPane serach box, ie "fwt::Combo#make" (not prefixed by plugin name)
- html
virtual override Str html(WebReq req, Str query, MatchKind matchKind)
Return html for a given path Note, the query will be prefixed with the plugin name for example /fantom/fwt::Button
- icon
virtual const override Image? icon := ...
- index
Return ruby index
- pluginName
virtual override Str pluginName()
name of the plugin responsible
- search